hola-server 1.0.10 → 2.0.1

package/core/date.js

@@ -1,55 +1,26 @@
-const date_format = require("dateformat");
-// import date_format from "dateformat";
-
 /**
- * Format the date object time part using HH:MM
- * @param {date object to be formatted} date
- * @returns
+ * @fileoverview Date formatting and parsing utility functions.
+ * @module core/date
  */
-const format_time = (date) => {
-  return date_format(date, "HH:MM");
-};
-
-/**
- * Format date object using mm/dd
- * @param {date object to be formatted} date
- * @returns
- */
-const simple_date = (date) => {
-  return date_format(date, "mm/dd");
-};
 
-/**
- * Format date obj using yyyymmdd
- * @param {date object to be formatted} date
- * @returns
- */
-const format_date = (date) => {
-  return date_format(date, "yyyymmdd");
-};
+const date_format = require("dateformat");
 
-/**
- * Format data obj using yyyymmdd hh:mm:ss
- * @param {date object to be formatted} date
- * @returns
- */
-const format_date_time = (date) => {
-  return date_format(date, "yyyymmdd HH:MM:ss");
-};
+const format_time = (date) => date_format(date, "HH:MM");
+const simple_date = (date) => date_format(date, "mm/dd");
+const format_date = (date) => date_format(date, "yyyymmdd");
+const format_date_time = (date) => date_format(date, "yyyymmdd HH:MM:ss");
 
 /**
- * Parse the date object using yyyymmdd format
- * @param {date str to be parsed} date
- * @returns
+ * Parse yyyymmdd formatted string to Date object.
+ * @param {string} date - Date string in yyyymmdd format.
+ * @returns {Date} Parsed Date object with time set to 00:00:00.
  */
 const parse_date = (date) => {
-  const year = parseInt(date.substr(0, 4));
-  const month = parseInt(date.substr(4, 2));
-  const day = parseInt(date.substr(6, 2));
-  const dateObj = new Date();
-  dateObj.setFullYear(year, month - 1, day);
-  dateObj.setHours(0, 0, 0, 0);
-  return dateObj;
+  const [year, month, day] = [date.slice(0, 4), date.slice(4, 6), date.slice(6, 8)].map(Number);
+  const date_obj = new Date();
+  date_obj.setFullYear(year, month - 1, day);
+  date_obj.setHours(0, 0, 0, 0);
+  return date_obj;
 };
 
 module.exports = { simple_date, format_date, format_time, format_date_time, parse_date };

package/core/encrypt.js

@@ -1,16 +1,26 @@
+/**
+ * @fileoverview Encryption and hashing utility functions.
+ * @module core/encrypt
+ */
+
 const crypto = require('crypto');
 const { get_settings } = require('../setting');
 
-const md5 = (content) => {
-    const md5 = crypto.createHash('md5');
-    return md5.update(content).digest('hex');
-}
+/**
+ * Generate MD5 hash of content.
+ * @param {string} content - Content to hash.
+ * @returns {string} MD5 hash in hex format.
+ */
+const md5 = (content) => crypto.createHash('md5').update(content).digest('hex');
 
+/**
+ * Encrypt password using MD5 with salt.
+ * @param {string} password - Plain text password.
+ * @returns {string} Encrypted password hash.
+ */
 const encrypt_pwd = (password) => {
     const crypto_key = get_settings().encrypt.key;
+    return md5(`BGT*&+${password}&76w${crypto_key}`);
+};
 
-    const str = `BGT*&+${password}&76w${crypto_key}`;
-    return md5(str);
-}
-
-module.exports = { encrypt_pwd };
+module.exports = { md5, encrypt_pwd };

package/core/file.js

@@ -1,38 +1,51 @@
-const fs = require('fs');
-const fs_promises = require('fs').promises;
+/**
+ * @fileoverview File system utility functions.
+ * @module core/file
+ */
 
+const fs = require('fs');
 const unzipper = require('unzipper');
 
-const file_extension = file_name => file_name ? file_name.split('.').pop() : "";
-const file_prefix = file_name => file_name ? file_name.split('.')[0] : "";
+/**
+ * Get file extension from filename.
+ * @param {string} file_name - Name of the file.
+ * @returns {string} File extension without dot.
+ */
+const file_extension = (file_name) => file_name ? file_name.split('.').pop() : "";
 
-const read_from_zip_by_extension = async (path, extension) => {
-    const directory = await unzipper.Open.file(path);
-    return directory.files.filter(file => extension == file_extension(file.path));
-}
+/**
+ * Get file name without extension.
+ * @param {string} file_name - Name of the file.
+ * @returns {string} File name prefix.
+ */
+const file_prefix = (file_name) => file_name ? file_name.split('.')[0] : "";
 
-const read_from_zip_by_prefix = async (path, prefix) => {
+/**
+ * Read files from zip archive with filter.
+ * @param {string} path - Path to zip file.
+ * @param {Function} predicate - Filter function for files.
+ * @returns {Promise<Object[]>} Array of matching file entries.
+ */
+const read_from_zip = async (path, predicate) => {
     const directory = await unzipper.Open.file(path);
-    return directory.files.filter(file => file_prefix(file.path) == prefix);
-}
+    return directory.files.filter(predicate);
+};
+
+const read_from_zip_by_extension = (path, extension) => read_from_zip(path, file => file_extension(file.path) === extension);
+const read_from_zip_by_prefix = (path, prefix) => read_from_zip(path, file => file_prefix(file.path) === prefix);
 
 /**
- * Check the file exist or not
- * @param {the file path} path 
- * @returns 
+ * Check if file exists at path.
+ * @param {string} path - File path to check.
+ * @returns {boolean} True if file exists, false otherwise.
  */
-const is_file_exist = (path) => {
-    try {
-        fs.accessSync(path, fs.F_OK);
-    } catch (e) {
-        return false;
-    }
-    return true;
-}
-
-const get_file_size = async (path) => {
-    const stats = await fs_promises.stat(path);
-    return stats.size;
-}
-
-module.exports = { file_extension, file_prefix, read_from_zip_by_extension, read_from_zip_by_prefix, is_file_exist, get_file_size }
+const is_file_exist = (path) => fs.existsSync(path);
+
+/**
+ * Get file size in bytes.
+ * @param {string} path - File path.
+ * @returns {Promise<number>} File size in bytes.
+ */
+const get_file_size = async (path) => (await fs.promises.stat(path)).size;
+
+module.exports = { file_extension, file_prefix, read_from_zip_by_extension, read_from_zip_by_prefix, is_file_exist, get_file_size };

package/core/lhs.js

@@ -1,27 +1,53 @@
+/**
+ * @fileoverview Template execution utilities using Node.js VM.
+ * @module core/lhs
+ */
 
 const vm = require('node:vm');
 const { range, scale, space } = require("./number");
 
-const get_context = () => { return { range: range, scale: scale, space: space } }
+/**
+ * Get default context with number utilities.
+ * @returns {Object} Context object with range, scale, and space functions.
+ */
+const get_context = () => ({ range, scale, space });
 
+/**
+ * Run code in VM context.
+ * @param {string} code - JavaScript code to execute.
+ * @param {Object} ctx - Context object for VM.
+ * @returns {Object} Context object after execution.
+ */
 const run_in_context = (code, ctx) => {
     vm.createContext(ctx);
     vm.runInContext(code, ctx);
     return ctx;
-}
+};
 
+/**
+ * Verify template string is valid JavaScript.
+ * @param {string} template - Template string to verify.
+ * @param {Object} knob - Variable bindings for template.
+ * @returns {string|null} Error message if invalid, null if valid.
+ */
 const verify_template = (template, knob) => {
     try {
         run_in_context("__output__=`" + template + "`;", knob);
+        return null;
     } catch (err) {
         return err.message;
     }
-    return null;
-}
+};
 
+/**
+ * Execute template string and return result.
+ * @param {string} template - Template string to execute.
+ * @param {Object} knob - Variable bindings for template.
+ * @returns {string} Executed template output.
+ */
 const execute_template = (template, knob) => {
     const ctx = run_in_context("__output__=`" + template + "`;", knob);
     return ctx["__output__"];
-}
+};
 
-module.exports = { get_context, run_in_context, verify_template, execute_template }
+module.exports = { get_context, run_in_context, verify_template, execute_template };