pathchain 1.1.4 → 1.1.6

package/checker.js

@@ -1,101 +1,72 @@
-var fs = require("fs");
-var emptyDir = require('empty-dir');
-var pb = require('protocol-buffers');
+const fs = require('fs');
+const emptyDir = require('empty-dir');
+const pb = require('protocol-buffers');
 
-// "./files/users"
-
-/** checkDir
- * [Function that creates directory if it does not exist]
- * 
- * @param {string} dir (required)
- * 
- * @return void
+/**
+ * Creates a directory if it does not exist.
+ * @param {string} dir - The directory path to check and create.
  */
-function checkDir(dir){
-    if (!fs.existsSync(dir)){
+function checkDir(dir) {
+    if (!fs.existsSync(dir)) {
         fs.mkdirSync(dir, { recursive: true });
     }
 }
 
-/** checkFiles
- * [Function that returns files in directory]
- * 
- * @param {string} dir (required)
- * 
- * @return void
+/**
+ * Returns an array of files in the specified directory.
+ * @param {string} dir - The directory path to check.
+ * @returns {string[]} An array of file names in the directory.
  */
-function checkFiles(dir){
-    var files = fs.readdirSync(dir);
-    return files;
+function checkFiles(dir) {
+    return fs.readdirSync(dir);
 }
 
-/** checkEmptyDir
- * [Function that returns TRUE if dir is empty, FALSE if not]
- * 
- * @param {string} dir (required)
- * 
- * @return {bool}  empty_dir
+/**
+ * Checks if the specified directory is empty.
+ * @param {string} dir - The directory path to check.
+ * @returns {boolean} True if the directory is empty, false otherwise.
  */
 function checkEmptyDir(dir) {
-    var empty_dir = emptyDir.sync(dir);
-    return empty_dir
+    return emptyDir.sync(dir);
 }
 
-/** checkFile
- * [Function that returns TRUE if file exists, FALSE if not]
- * 
- * @param {string} dir (required)
- * 
- * @return {bool} empty_dir
+/**
+ * Checks if a file exists at the specified path.
+ * @param {string} dir - The file path to check.
+ * @returns {boolean} True if the file exists, false otherwise.
  */
-function checkFile(dir){
+function checkFile(dir) {
     try {
-        if (fs.existsSync(dir)) {
-          return true;
-        }
-      } catch(err) {
-        console.error(err)
+        return fs.existsSync(dir);
+    } catch (err) {
+        console.error(err);
+        return false;
     }
-    return false;
 }
 
-
-/** isSecretUsed
- * [Function that returns TRUE if secret has been used, FALSE if not]
- * 
- * @param {string} xsecret (required)
- * 
- * @return {bool}  used_secret
+/**
+ * Checks if a secret has been used.
+ * @param {string} xsecret - The secret hash.
+ * @param {string} [xauthor=''] - The author of the secret (optional).
+ * @returns {boolean|string} True if the secret has been used, false if not, or an error message.
  */
-function isSecretUsed(xsecret, xauthor = "") {
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
+function isSecretUsed(xsecret, xauthor = '') {
+    const secretProto = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}secrets/${xsecret}`;
 
-    // LOADING PB
-    var secret_pb = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'))
-    
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "secrets/" + xsecret);
+        const fileContents = fs.readFileSync(filePath);
+        const secretObj = secretProto.secret.decode(fileContents);
+        return secretObj.used;
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Secret not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? 'Secret not found' : err;
     }
-
-    // DECODING SECRET
-    var secret_enc = fileContents
-    var secret_obj = secret_pb.secret.decode(secret_enc)
-
-    return secret_obj.used;
 }
 
-// CHECKING THE SECRET CHECKS THE SECRET
-
-module.exports = { checkDir, checkFiles, checkFile, checkEmptyDir, isSecretUsed };
-
-                                                                         
+module.exports = {
+    checkDir,
+    checkFiles,
+    checkFile,
+    checkEmptyDir,
+    isSecretUsed
+};

package/getter.js

@@ -1,301 +1,168 @@
-var fs = require("fs");
-var pb = require('protocol-buffers');
-var dt = require('date-and-time');
-// const { getLinkObj } = require(".");
-
-/** getCurrentDate
- * [Function that returns current datetime string on "MMM DD YYYY HH:mm:ss [GMT]Z" format]
- * 
- * @return {string} current_datetime
+const fs = require('fs');
+const pb = require('protocol-buffers');
+const dt = require('date-and-time');
+
+/**
+ * Returns the current datetime string in the specified format.
+ * @param {string} [format='MM DD YYYY HH:mm:SSS [GMT]Z'] - The desired date format.
+ * @returns {string} The formatted current datetime.
  */
-function getCurrentDate(format = 'MM DD YYYY HH:mm:SSS [GMT]Z'){
-    var current_datetime = new Date()
-    current_datetime = dt.format(current_datetime, dt.compile(format, true));
-
-    return current_datetime;
+function getCurrentDate(format = 'MM DD YYYY HH:mm:SSS [GMT]Z') {
+    const currentDatetime = new Date();
+    return dt.format(currentDatetime, dt.compile(format, true));
 }
 
-/** getMomentObj
- * [Function that recieves a moment hash and returns the moment object]
- * 
- * @param {string} xmoment (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a moment object from a file.
+ * @param {string} xmoment - The moment hash or path.
+ * @returns {Object|string} The decoded moment object or an error message.
  */
 function getMomentObj(xmoment) {
-    // "moments/hash" FORMAT EXCEPTION
-    if(xmoment.split("/").length > 1){ 
-        xmoment = xmoment.split("/")[1]
-    }
-
-    // LOADING PB
-    var moment_pb = pb(fs.readFileSync('node_modules/pathchain/proto/moment.proto'))
+    // Handle "moments/hash" format
+    const momentHash = xmoment.includes('/') ? xmoment.split('/')[1] : xmoment;
+    
+    const momentProto = pb(fs.readFileSync('node_modules/pathchain/proto/moment.proto'));
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/moments/"+xmoment);
+        const fileContents = fs.readFileSync(`files/moments/${momentHash}`);
+        return momentProto.moment.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Moment buffer not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Moment buffer not found" : err;
     }
-
-    // DECODING MOMENT
-    var moment_enc = fileContents
-    var moment_obj = moment_pb.moment.decode(moment_enc)
-
-    return moment_obj;
 }
 
-/** getPioneerObj
- * [Function that recieves a pioneer hash and returns the pioneer object]
- * 
- * @param {string} xpioneer (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a pioneer object from a file.
+ * @param {string} xpioneer - The pioneer hash.
+ * @returns {Object|string} The decoded pioneer object or an error message.
  */
 function getPioneerObj(xpioneer) {
-
-    // LOADING PB
-    var pioneer_pb = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'))
+    const pioneerProto = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'));
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/pioneer/"+xpioneer);
+        const fileContents = fs.readFileSync(`files/pioneer/${xpioneer}`);
+        return pioneerProto.entity.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Pioneer not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Pioneer not found" : err;
     }
-
-
-    // DECODING PIONEER
-    var pioneer_enc = fileContents
-    var pioneer_obj = pioneer_pb.entity.decode(pioneer_enc)
-
-    return pioneer_obj;
 }
 
-
-/** getSecretObj
- * [Function that recieves a secret hash and returns the secret object]
- * 
- * @param {string} xsecret (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a secret object from a file.
+ * @param {string} xsecret - The secret hash.
+ * @param {string} xauthor - The author of the secret (optional).
+ * @returns {Object|string} The decoded secret object or an error message.
  */
-function getSecretObj(xsecret, xauthor) {
-
-    if(xauthor != "" && (typeof xauthor !== 'undefined')){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var secret_pb = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'))
+function getSecretObj(xsecret, xauthor = '') {
+    const secretProto = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}secrets/${xsecret}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "secrets/" + xsecret);
+        const fileContents = fs.readFileSync(filePath);
+        return secretProto.secret.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Secret not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Secret not found" : err;
     }
-
-    // DECODING SECRET
-    var secret_enc = fileContents
-    var secret_obj = secret_pb.secret.decode(secret_enc)
-
-    return secret_obj;
 }
 
-
-/** getEntityObj
- * [Function that recieves a entity hash and returns the entity object]
- * 
- * @param {string} xentity (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes an entity object from a file.
+ * @param {string} xentity - The entity hash.
+ * @param {string} xauthor - The author of the entity (optional).
+ * @returns {Object|string} The decoded entity object or an error message.
  */
-function getEntityObj(xentity, xauthor) {
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var entity_pb = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'))
+function getEntityObj(xentity, xauthor = '') {
+    const entityProto = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}entities/${xentity}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "entities/" + xentity);
+        const fileContents = fs.readFileSync(filePath);
+        return entityProto.entity.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Entity not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Entity not found" : err;
     }
-
-    // DECODING ENTITY
-    var entity_enc = fileContents
-    var entity_obj = entity_pb.entity.decode(entity_enc)
-
-    return entity_obj;
 }
 
-/** getNodeObj
- * [Function that recieves a node hash and returns the node object]
- * 
- * @param {string} xnode (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a node object from a file.
+ * @param {string} xnode - The node hash.
+ * @param {string} xauthor - The author of the node (optional).
+ * @returns {Object|string} The decoded node object or an error message.
  */
-function getNodeObj(xnode, xauthor) {
-
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var node_pb = pb(fs.readFileSync('node_modules/pathchain/proto/node.proto'))
+function getNodeObj(xnode, xauthor = '') {
+    const nodeProto = pb(fs.readFileSync('node_modules/pathchain/proto/node.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}nodes/${xnode}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "nodes/" + xnode);
+        const fileContents = fs.readFileSync(filePath);
+        return nodeProto.node.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Node not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Node not found" : err;
     }
-
-    // DECODING NODE
-    var node_enc = fileContents
-    var node_obj = node_pb.node.decode(node_enc)
-
-    return node_obj;
 }
 
-
-/** getLinkObj
- * [Function that recieves a link hash and returns the link object]
- * 
- * @param {string} xlink (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a link object from a file.
+ * @param {string} xlink - The link hash.
+ * @param {string} xauthor - The author of the link (optional).
+ * @returns {Object|string} The decoded link object or an error message.
  */
-function getLinkObj(xlink, xauthor) {
-
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var link_pb = pb(fs.readFileSync('node_modules/pathchain/proto/link.proto'))
+function getLinkObj(xlink, xauthor = '') {
+    const linkProto = pb(fs.readFileSync('node_modules/pathchain/proto/link.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}links/${xlink}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "links/" + xlink);
+        const fileContents = fs.readFileSync(filePath);
+        return linkProto.link.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Link not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Link not found" : err;
     }
-
-    // DECODING NODE
-    var link_enc = fileContents
-    var link_obj = link_pb.link.decode(link_enc)
-
-    return link_obj;
 }
 
-
-/** getPathObj
- * [Function that recieves a path hash and returns the path object]
- * 
- * @param {string} xpath (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a path object from a file.
+ * @param {string} xpath - The path hash.
+ * @param {string} xauthor - The author of the path (optional).
+ * @returns {Object|string} The decoded path object or an error message.
  */
-function getPathObj(xpath, xauthor) {
-
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var path_pb = pb(fs.readFileSync('node_modules/pathchain/proto/path.proto'))
+function getPathObj(xpath, xauthor = '') {
+    const pathProto = pb(fs.readFileSync('node_modules/pathchain/proto/path.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}paths/${xpath}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "paths/" + xpath);
+        const fileContents = fs.readFileSync(filePath);
+        return pathProto.path.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Path not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Path not found" : err;
     }
-
-    // DECODING PATH
-    var path_enc = fileContents
-    var path_obj = path_pb.path.decode(path_enc)
-
-    return path_obj;
 }
 
-
-
-/** getLabelObj
- * [Function that recieves a label hash and returns the label object]
- * 
- * @param {string} xlabel (required)
- * 
- * @return void
+/**
+ * Retrieves and decodes a label object from a file.
+ * @param {string} xlabel - The label hash.
+ * @param {string} xauthor - The author of the label (optional).
+ * @returns {Object|string} The decoded label object or an error message.
  */
-function getLabelObj(xlabel, xauthor) {
-
-    if(xauthor != ""){
-        xauthor = xauthor + '/';
-    }
-
-    // LOADING PB
-    var label_pb = pb(fs.readFileSync('node_modules/pathchain/proto/label.proto'))
+function getLabelObj(xlabel, xauthor = '') {
+    const labelProto = pb(fs.readFileSync('node_modules/pathchain/proto/label.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}labels/${xlabel}`;
     
-    // NOT FOUND EXCEPTION
-    var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + xauthor + "labels/" + xlabel);
+        const fileContents = fs.readFileSync(filePath);
+        return labelProto.label.decode(fileContents);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            return "Label not found";
-        } else {
-            throw err;
-        }
+        return err.code === 'ENOENT' ? "Label not found" : err;
     }
-
-    // DECODING LABEL
-    var label_enc = fileContents
-    var label_obj = label_pb.label.decode(label_enc)
-
-    return label_obj;
 }
 
-
-module.exports = { getCurrentDate, getMomentObj, getPioneerObj, getSecretObj, getEntityObj, getNodeObj, getLinkObj, getPathObj, getLabelObj }
+module.exports = {
+    getCurrentDate,
+    getMomentObj,
+    getPioneerObj,
+    getSecretObj,
+    getEntityObj,
+    getNodeObj,
+    getLinkObj,
+    getPathObj,
+    getLabelObj
+};

package/maker.js

@@ -143,13 +143,12 @@ function entity(xsecret, format) {
             const register = dt.format(new Date(), dt.compile(format, true));
             const register_moment_hash = moment(register, 0, 0, 0, 0, 0, format);
             const ancestor_entity_hash = getter.getSecretObj(xsecret, "").author;
-            console.log("MAKER :: ENTITY :: xsecret obj : ", getter.getSecretObj(xsecret));
 
             const entity_hash = sha256(`${register_moment_hash}_${ancestor_entity_hash}`);
 
             const buffer = entity.entity.encode({
                 register: `moments/${register_moment_hash}`,
-                ancestor: `entities/${ancestor_entity_hash}`,
+                ancestor: `${ancestor_entity_hash}`,
                 tag: `entities/${entity_hash}`,
             });
 

package/package.json

@@ -34,5 +34,5 @@
   "deprecated": false,
   "description": "![image](https://user-images.githubusercontent.com/104391124/282268780-cbbc1ee6-8d97-4d80-b896-66ae3eb723dd.png)",
   "name": "pathchain",
-  "version": "1.1.4"
+  "version": "1.1.6"
 }