pathchain 1.1.16 → 1.1.17

package/README.md

@@ -1,54 +1,87 @@
 # pathchain [![npm version](https://badge.fury.io/js/pathchain.svg)](https://badge.fury.io/js/pathchain) [![open source](https://img.shields.io/badge/open%20source-pathchain-grey?labelColor=purple&style=flat&logo=Github&logoColor=white&link=https://github.com/The-Dream-Operator-s-Garage/pathchain)](https://github.com/The-Dream-Operator-s-Garage/pathchain)
 ![image](https://user-images.githubusercontent.com/104391124/282268780-cbbc1ee6-8d97-4d80-b896-66ae3eb723dd.png)
 
-
 Pathchain is a tool to build path-shaped data structures that are chained one to another from the very moment the tool is initialized. The data behaves like a data tree where you can track the very origin of anything by tracking the origin file hashnames that created any hashname of any file in the chain. Pathchain uses Google's Protocol Buffers to encode and decode the data structures optimally and SHA-256 to build the hashname chain.
 
 ---
 # Pathchain documentation
 
-
+# Core Function
+| Function          | Parameters       |
+| ----------------- | ---------------- |
+| [`hello()`](#Hello) | name             |
 
 # Makers
-Maker functions recieve new data to encode into the chain.
+Maker functions receive new data to encode into the chain.
 
 | Function                      | Parameters                              |
 | ----------------------------- | --------------------------------------- |
 | [`makeMoment()`](#Moment)     | datetime, lat, lon, x, y, z, format     |
-| [`makePioneer()`](#Pioneer)   | format                                  |
+| [`makePioneer()`](#Pioneer)   | datetime, format                        |
 | [`makeSecret()`](#Secret)     | author, format                          |
 | [`makeEntity()`](#Entity)     | xsecret, format                         |
 | [`makeNode()`](#Node)         | text, xauthor, format                   |
-| [`makeNodelink()`](#Nodelink) | first, second, author, ancestor, format |
-| [`makePath()`](#Path)         | xauthor, text, head, ancestor, format   |
-| [`makePathlink()`](#Pathlink) | first, second, author, ancestor, format |
-| [`makeTree()`](#Tree)         | xauthor, text, head, ancestor, format   |
-
+| [`makeLink()`](#Link)         | target, prev, next, xauthor, ancestor, format |
+| [`makePath()`](#Path)         | text, head, xauthor, ancestor, format   |
+| [`makeLabel()`](#Label)       | text, xauthor, ancestor, format         |
 
 ---
 # Getters
 Getter functions retrieve objects given a hashname and author information
 
-| Function                     | Parameters                               |
-| ---------------------------- | ---------------------------------------- |
-| [`getMoment()`](#Moment)     | xmoment                                  |
-| [`getPioneer()`](#Pioneer)   | (none)                                   |
-| [`getSecret()`](#Secret)     | xsecret, xauthor                         |
-| [`getEntity()`](#Entity)     | xentity, xauthor                         |
-| [`getNode()`](#Node)         | xnode, xauthor                           |
-| [`getNodelink()`](#Nodelink) | xnodelink, xauthor                       |
-| [`getPath()`](#Path)         | xpath, xauthor                           |
-| [`getPathlink()`](#Pathlink) | xpathlink, xauthor                       |
-| [`getTree()`](#Tree)         | xtree, xauthor                           |
-| [`getTreelink()`](#Treelink) | xtreelink, xauthor                       |
+| Function                      | Parameters                               |
+| ----------------------------- | ---------------------------------------- |
+| [`getMomentObj()`](#Moment)   | xmoment                                  |
+| [`getPioneerObj()`](#Pioneer) | xpioneer                                 |
+| [`getSecretObj()`](#Secret)   | xsecret, xauthor                         |
+| [`getEntityObj()`](#Entity)   | xentity, xauthor                         |
+| [`getNodeObj()`](#Node)       | xnode, xauthor                           |
+| [`getLinkObj()`](#Link)       | xlink, xauthor                           |
+| [`getPathObj()`](#Path)       | xpath, xauthor                           |
+| [`getPathChainObj()`](#Path)  | xpath, xauthor                           |
+| [`getPatheadObj()`](#Path)    | xaddress                                 |
+| [`getLabelObj()`](#Label)     | xlabel, xauthor                          |
+| [`getObj()`](#Common)         | xaddress                                 |
+
+---
+# Other Functions
+| Function                      | Parameters                               |
+| ----------------------------- | ---------------------------------------- |
+| [`useSecret()`](#Secret)      | xsecret                                  |
+| [`isSecretUsed()`](#Secret)   | xsecret                                  |
+
+---
+## Hello
+
+A simple greeting function that confirms the library is working properly.
+
+#### Hello function
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} name            |(optional)|
+
+---
+Summoning `hello(name)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+const greeting = pathchain.hello("User"); // Simple greeting
+console.log(greeting); // Printing
+```
 
+Console: 
+``` bash
+Hello from the Dream Operator's Garage, User
+```
 
 ---
 ## Moment
 
-A moment is the mimimum representation of the pathchain data structures. Moments are the trunk of every path . They're represented by default with a `MM DD YYYY HH:mm:SSS [GMT]Z` datetime format for `time` and a planet earth representation (0, 0, 0) in general as `space`.
+A moment is the minimum representation of the pathchain data structures. Moments are the trunk of every path. They're represented by default with a `MM DD YYYY HH:mm:SSS [GMT]Z` datetime format for `time` and a planet earth representation (0, 0, 0) in general as `space`.
 
-`<moment>` :: space and time data ::= { `<“moments/”>` + sha256(`<moment>`) }
+`<moment>` :: space and time data ::= { `<"moments/">` + sha256(`<moment>`) }
 
 #### Protocol Buffer file:
 
@@ -109,7 +142,7 @@ Summoning `makeMoment(datetime, lat, lon, x, y, z, format)`:
 const pathchain = require("pathchain"); // Summoning pathchain
 
 const moment_pb = pathchain.makeMoment(); // Making moment
-console.log("Moment buffer: ", moment); // Printing
+console.log("Moment buffer: ", moment_pb); // Printing
 ```
 
 Console: 
@@ -122,17 +155,17 @@ Moment buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} xauthor  |(optional)|
-|{string} xmoment  |(required)|
+|{string} xmoment         |(required)|
 
 
 ---
-Summoning `getMomentObj(xauthor, xmoment)`
-```
+Summoning `getMomentObj(xmoment)`:
+```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-const moment_pb = pathchain.makeMoment(); // Moment creation
-var moment_obj = pathchain.getMomentObj(moment_buff); // Printing
+const moment_buff = pathchain.makeMoment(); // Moment creation
+var moment_obj = pathchain.getMomentObj(moment_buff); // Getting object
+console.log("Moment object: ", moment_obj); // Printing
 ```
 
 Console: 
@@ -161,7 +194,7 @@ Moment object:  {
 
 A secret is an OTP (One Time Password) generated by an entity. The moment it is used, it becomes useless. Secrets are represented as SHA-256 hashes, like everything on pathchain.
 
-`<secret>` :: secret hash generated by an entity ::= { `<“secrets/”>` + sha256(`<moment>` + `<entity>`) }
+`<secret>` :: secret hash generated by an entity ::= { `<"secrets/">` + sha256(`<moment>` + `<entity>`) }
 
 #### Protocol Buffer file:
 
@@ -181,16 +214,16 @@ message secret {
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} author          |(required)|
+|{string} author          |(optional)|
 |{string} format          |(optional)|
 
 ---
-Summoning `makeMoment(author, format)`:
+Summoning `makeSecret(author, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-var sec_pioneer_buff = pathchain.makeSecret(author); // Making a secret with an existing entity hash
-console.log("Secret buffer: ", secret); // Printing
+var secret_buff = pathchain.makeSecret(); // Making a secret with default pioneer as author
+console.log("Secret buffer: ", secret_buff); // Printing
 ```
 
 Console: 
@@ -211,17 +244,17 @@ Summoning `useSecret(xsecret)` & `isSecretUsed(xsecret)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-var secret_buff = pathchain.makeSecret(author); // Making a secret with an existing entity hash
-console.log("Secret buffer: ", secret); // Printing
+var secret_buff = pathchain.makeSecret(); // Making a secret with default pioneer
+console.log("Secret buffer: ", secret_buff); // Printing
 
 // Checking if the secret has been used (before using it)
 var used = pathchain.isSecretUsed(secret_buff);
 console.log("Secret buffer used?: ", used); // Printing
 
 // Using the secret
-pathchain.useSecret(secret_buff, xentity);
+pathchain.useSecret(secret_buff);
 
-// Checking if the secret has been used (before using it)
+// Checking if the secret has been used (after using it)
 var used = pathchain.isSecretUsed(secret_buff);
 console.log("Secret buffer used?: ", used); // Printing
 ```
@@ -229,13 +262,7 @@ console.log("Secret buffer used?: ", used); // Printing
 Console: 
 ``` bash
 Secret buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
-```
-
-``` bash
 Secret buffer used?: false
-```
-
-``` bash
 Secret buffer used?: true
 ```
 
@@ -246,18 +273,16 @@ Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
 |{string} xsecret         |(required)|
+|{string} xauthor         |(optional)|
 
 
 ---
-Summoning `getSecretObj(xsecret)`:
+Summoning `getSecretObj(xsecret, xauthor)`:
 ```javascript
-
 const pathchain = require("pathchain"); // Summoning pathchain
 
-const secret_buff = pathchain.makeSecret(author); // Secret creation
-
-var secret_obj = pathchain.getSecretObj(secret_buff); //   Getting object from hashname
-
+const secret_buff = pathchain.makeSecret(); // Secret creation
+var secret_obj = pathchain.getSecretObj(secret_buff); // Getting object from hashname
 console.log("Secret object: ", secret_obj); // Printing
 ```
 
@@ -276,7 +301,7 @@ Secret object:  {
 
 A pioneer is a user with all its content made public. It is the first entity on the system and can only generate one [secret](#Secret) in order to initiate the human chain for the system. The pioneer buffer exists as a single buffer in the `pioneer` folder and as an [entity](#Entity) in the `entities` folder.
 
-`<pioneer>` :: pioneer entity ::= { `<“pioneer/”>` + sha256(`<moment>` +  `<moment>`) }
+`<pioneer>` :: pioneer entity ::= { `<"pioneer/">` + sha256(`<moment>` +  `<moment>`) }
 
 
 #### Pioneer maker
@@ -284,17 +309,16 @@ A pioneer is a user with all its content made public. It is the first entity on
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|                         |(nothing) |
+|{string} datetime        |(optional)|
+|{string} format          |(optional)|
 
 
 ---
-Summoning `makePioneer()`:
+Summoning `makePioneer(datetime, format)`:
 ```javascript
-
 const pathchain = require("pathchain"); // Summoning pathchain
 
 var pioneer_buff = pathchain.makePioneer(); // Pioneer creation
-
 console.log("Pioneer buffer: ", pioneer_buff);
 ```
 
@@ -303,23 +327,21 @@ Console:
 Pioneer buffer:  d945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f
 ```
 
-** If you summon `makePioneer()` again, it will always return the original pioneer. The pioneer will be the same forever and ever!. For the same reason, summoning `getPioneerObj()` does not require parameters. If the pioneer does not exist, it is automatically created by the system. **
+**Note: If you summon `makePioneer()` again, it will always return the original pioneer. The pioneer will be the same forever. For the same reason, summoning `getPioneerObj()` does not necessarily require parameters. If the pioneer does not exist, it is automatically created by the system.**
 
 #### Pioneer getter
 
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|                         |(nothing) |
+|{string} xpioneer        |(optional)|
 
 
 ---
-Summoning `getPioneerObj()`:
+Summoning `getPioneerObj(xpioneer)`:
 ```javascript
-
 const pathchain = require("pathchain"); // Summoning pathchain
 
-
 var pioneer_buff = pathchain.makePioneer(); // Pioneer creation
 var pioneer_obj = pathchain.getPioneerObj();
 
@@ -341,9 +363,9 @@ Pioneer object:  {
 
 ## Entity
 
-Entities are the actors/users that create/author and organize information on the pathchain. Entities are linked to information from their origin and their relationship with other entities and data in the system. Entities can expand and organize with other entities to publish or modify data in the name of an 'alter-ego' or an 'organization'. An entity can only join the pathchain using another entitie(s) secret.
+Entities are the actors/users that create/author and organize information on the pathchain. Entities are linked to information from their origin and their relationship with other entities and data in the system. Entities can expand and organize with other entities to publish or modify data in the name of an 'alter-ego' or an 'organization'. An entity can only join the pathchain using another entity's secret.
 
-`<entity>` :: entity ::= { `<“entities/”>` + sha256(`<moment>` + `<entity>`) }
+`<entity>` :: entity ::= { `<"entities/">` + sha256(`<moment>` + `<entity>`) }
 
 
 #### Protocol Buffer file:
@@ -364,17 +386,20 @@ message entity {
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} author          |(required)|
+|{string} xsecret         |(required)|
 |{string} format          |(optional)|
 
 
 ---
-Summoning `makeEntity(secret, format)`:
+Summoning `makeEntity(xsecret, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-// Entity creation
-var entity_buff = pathchain.makeEntity(secret);
+// First create a secret
+var secret_buff = pathchain.makeSecret();
+
+// Entity creation using that secret
+var entity_buff = pathchain.makeEntity(secret_buff);
 
 console.log("Entity buffer: ", entity_buff);
 ```
@@ -391,15 +416,19 @@ Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
 |{string} xentity         |(required)|
+|{string} xauthor         |(optional)|
 
 
 ---
-Summoning `getEntityObj(xentity)`:
+Summoning `getEntityObj(xentity, xauthor)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
+// Create a secret
+var secret_buff = pathchain.makeSecret();
+
 // Entity creation
-var entity_buff = pathchain.makeEntity(secret);
+var entity_buff = pathchain.makeEntity(secret_buff);
 
 // Getting entity obj
 var entity_obj = pathchain.getEntityObj(entity_buff);
@@ -423,7 +452,7 @@ Entity object:  {
 
 Nodes are the primary data storage elements of the pathchain. They can be the representation of plain `text`, the direction of a `file`, or an internet `url`. 
 
-`<node>` :: node ::= { `<“nodes/”>` + sha256(`<moment>` + `<author>` + `<content>`) }
+`<node>` :: node ::= { `<"nodes/">` + sha256(`<moment>` + `<author>` + `<content>`) }
 
 
 #### Protocol Buffer file:
@@ -447,18 +476,18 @@ message node {
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} author          |(optional)|
 |{string} text            |(optional)|
+|{string} xauthor         |(optional)|
 |{string} format          |(optional)|
 
 
 ---
-Summoning `makeNode(author, text, format)`:
+Summoning `makeNode(text, xauthor, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
 // Node creation
-var node_buff = pathchain.makeNode(author, content);
+var node_buff = pathchain.makeNode("This is a test node");
 
 console.log("Node buffer: ", node_buff);
 ```
@@ -479,12 +508,12 @@ Parameter rules:
 
 
 ---
-Summoning `getNodeObj(xnode)`:
+Summoning `getNodeObj(xnode, xauthor)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
 // Node creation
-var node_buff = pathchain.makeNode(secret);
+var node_buff = pathchain.makeNode("Learning to fly, one step closer to knowing");
 
 // Getting node obj
 var node_obj = pathchain.getNodeObj(node_buff);
@@ -509,7 +538,7 @@ Node object:  {
 
 Links are the joints of the paths. They __link__ one node with another. 
 
-`<link>` :: link ::= { `<“links/”>` + sha256(`<moment>` + `<author>` + `<target>` + `<prev>` + `<next>`) }
+`<link>` :: link ::= { `<"links/">` + sha256(`<moment>` + `<author>` + `<target>` + `<prev>` + `<next>`) }
 
 
 #### Protocol Buffer file:
@@ -517,7 +546,7 @@ Links are the joints of the paths. They __link__ one node with another.
 ``` proto
 syntax = "proto3";
 
-message nodelink {
+message link {
     required string register = 1;
     required string author = 2;
     required string ancestor = 3;
@@ -529,26 +558,29 @@ message nodelink {
 ```
 
 
-#### link maker
+#### Link maker
 
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} target          |(required)|
+|{string} target          |(optional)|
 |{string} prev            |(optional)|
 |{string} next            |(optional)|
-|{string} author          |(optional)|
+|{string} xauthor         |(optional)|
 |{string} ancestor        |(optional)|
 |{string} format          |(optional)|
 
 
 ---
-Summoning `makeLink(target, prev, next, author, ancestor, format)`:
+Summoning `makeLink(target, prev, next, xauthor, ancestor, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-// Nodelink creation
-var link_buff = pathchain.makelink(target);
+// Create a node to target
+var node_buff = pathchain.makeNode("Target node");
+
+// Link creation
+var link_buff = pathchain.makeLink(node_buff);
 
 console.log("Link buffer: ", link_buff);
 ```
@@ -569,18 +601,21 @@ Parameter rules:
 
 
 ---
-Summoning `getlinkObj(xlink)`:
+Summoning `getLinkObj(xlink, xauthor)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
-// Nodelink creation
-var link_buff = pathchain.makeLink(node_buff, "ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7");
+// Create a node to target
+var node_buff = pathchain.makeNode("Target node");
+
+// Link creation
+var link_buff = pathchain.makeLink(node_buff);
 
 // Getting link obj
 var link_obj = pathchain.getLinkObj(link_buff);
 
-console.log("link buffer: ", link_buff);
-console.log("link object: ", link_obj);
+console.log("Link buffer: ", link_buff);
+console.log("Link object: ", link_obj);
 ```
 
 Console: 
@@ -601,7 +636,7 @@ Link object:  {
 
 Paths are the skeleton of the data trees built on pathchain. They are a linear way to connect data.
 
-`<path>` :: path ::= { `<“paths/”>` + sha256(`<moment>` + `<author>` + `<head>`) }
+`<path>` :: path ::= { `<"paths/">` + sha256(`<moment>` + `<author>` + `<head>`) }
 
 #### Protocol Buffer file:
 
@@ -625,19 +660,24 @@ message path {
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} xauthor         |(required)|
-|{string} text            |(required)|
-|{string} head            |(required)|
+|{string} text            |(optional)|
+|{string} head            |(optional)|
+|{string} xauthor         |(optional)|
+|{string} ancestor        |(optional)|
 |{string} format          |(optional)|
 
 
 ---
-Summoning `makePath(secret, text, format)`:
+Summoning `makePath(text, head, xauthor, ancestor, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
+// First create a link to use as head
+var node_buff = pathchain.makeNode("First node in path");
+var link_buff = pathchain.makeLink(node_buff);
+
 // Path creation
-var path_buff = pathchain.makePath(author, text, head);
+var path_buff = pathchain.makePath("My first path", link_buff);
 
 console.log("Path buffer: ", path_buff);
 ```
@@ -648,7 +688,7 @@ Path buffer:  a0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 ```
 
 
-#### Path getter
+#### Path getters
 
 Parameter rules:
 |Parameter                |Required  |
@@ -658,12 +698,16 @@ Parameter rules:
 
 
 ---
-Summoning `getPathObj(xpath)`:
+Summoning `getPathObj(xpath, xauthor)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
+// Create a node and link
+var node_buff = pathchain.makeNode("First node in path");
+var link_buff = pathchain.makeLink(node_buff);
+
 // Path creation
-var path_buff = pathchain.makePath(secret);
+var path_buff = pathchain.makePath("My first path", link_buff);
 
 // Getting path obj
 var path_obj = pathchain.getPathObj(path_buff);
@@ -678,10 +722,114 @@ Path buffer:  426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31
 Path object:  {
   register: 'moments/0fede6ab5d5078f7cb535cfdf50f7339c02e343fd9793bd7d68bd544e984ab5b',
   author: 'ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
-  text: 'pathlink',
-  head: 'nodelinks/1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac',
+  text: 'My first path',
+  head: 'links/1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac',
   ancestor: 'paths/426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31',
   chain: '',
   tag: 'paths/426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31'
 }
 ```
+
+Summoning `getPathchainObj(xpath, xauthor)` returns the path with its complete chain:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Get path created earlier
+var path_chain_obj = pathchain.getPathchainObj(path_buff);
+
+console.log("Path chain obj: ", path_chain_obj);
+```
+
+Summoning `getPatheadObj(xaddress)` returns the head object of a path:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Get the head object of a path
+var path_head_obj = pathchain.getPatheadObj(path_buff);
+
+console.log("Path head object: ", path_head_obj);
+```
+
+## Label
+
+Labels are used to tag and categorize other elements in the pathchain system.
+
+`<label>` :: label ::= { `<"labels/">` + sha256(`<moment>` + `<author>` + `<text>`) }
+
+#### Label maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} text            |(optional)|
+|{string} xauthor         |(optional)|
+|{string} ancestor        |(optional)|
+|{string} format          |(optional)|
+
+
+---
+Summoning `makeLabel(text, xauthor, ancestor, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Label creation
+var label_buff = pathchain.makeLabel("Important");
+
+console.log("Label buffer: ", label_buff);
+```
+
+Console: 
+``` bash
+Label buffer:  f0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+
+#### Label getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xlabel          |(required)|
+|{string} xauthor         |(optional)|
+
+
+---
+Summoning `getLabelObj(xlabel, xauthor)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Label creation
+var label_buff = pathchain.makeLabel("Important");
+
+// Getting label obj
+var label_obj = pathchain.getLabelObj(label_buff);
+
+console.log("Label buffer: ", label_buff);
+console.log("Label object: ", label_obj);
+```
+
+## Common
+
+Pathchain provides some generic getter functions that can work with any type of object in the system.
+
+#### Generic Object getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xaddress        |(required)|
+
+
+---
+Summoning `getObj(xaddress)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Create any object
+var node_buff = pathchain.makeNode("Test node");
+
+// Get generic object
+var obj = pathchain.getObj(node_buff);
+
+console.log("Object: ", obj);
+```

package/getter.js

@@ -226,6 +226,38 @@ function getPatheadObj(xpath, xauthor = '') {
     }
 }
 
+/**
+ * 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 getPathchainObj(xpath, xauthor = '') {
+    const pathProto = pb(fs.readFileSync('node_modules/pathchain/proto/path.proto'));
+    const filePath = `files/${xauthor ? xauthor + '/' : ''}paths/${xpath}`;
+    
+    try {
+        const fileContents = fs.readFileSync(filePath);
+        var pathObj =  pathProto.path.decode(fileContents);
+
+        var current_link = this.getObj(pathObj.head);
+        console.log("Head link", current_link);
+        var current_obj = this.getObj(current_link.target);
+        console.log("First object", current_obj);
+
+        let obj_list = [];
+        // append targets to obj_list until the link's prev property points to itself
+        while (current_link.prev !== current_link.target) {
+            obj_list.push(current_obj);
+            current_link = this.getObj(current_link.prev);
+            current_obj = this.getObj(current_link.target);
+        }
+        // Get link -> get link.target
+        return obj_list;
+    } catch (err) {
+        return err.code === 'ENOENT' ? "Path not found" : err;
+    }
+}
 
 module.exports = {
     getCurrentDate,
@@ -238,5 +270,6 @@ module.exports = {
     getPathObj,
     getLabelObj,
     getObj,
-    getPatheadObj
+    getPatheadObj,
+    getPathchainObj
 };

package/index.js

@@ -287,7 +287,7 @@ exports.getObj = (xaddress) => {
     return pathchain_object;
 }
 
-/** getPathChainObj
+/** getPatheadObj
  * [Function that recieves a path hash and returns the path object]
  * 
 
@@ -298,4 +298,17 @@ exports.getObj = (xaddress) => {
 exports.getPatheadObj = (xaddress) => {
     const pathchain_object = getter.getPatheadObj(xaddress);
     return pathchain_object;
+}
+
+/** getPathchainObj
+ * [Function that recieves a path hash and returns the path object]
+ * 
+
+ * Retrieves and decodes a address object from a file.
+ * @param {string} xaddress - The address string.
+ * @returns {Object|string} The decoded object or an error message.
+ */
+exports.getPatchainObj = (xaddress) => {
+    const pathchain_object = getter.getPatchainObj(xaddress);
+    return pathchain_object;
 }

package/maker.js

@@ -230,15 +230,18 @@ function path(text, elements, author, ancestor, format = 'MM DD YYYY HH:mm:SSS [
  
     let prev_link = "";
     let head_link = "";
-    
+
     // Building target chain
     for (let i = 0; i < elements.length; i++) {
+        // link with no next and no prev is set with its target as the current element
         const current_link = link(elements[i], "", "", author, "");
-        if(i==0) head_link = current_link;
+        // onli if this is not the first element
         if (i > 0) {
             updater.setLinkNext(prev_link, current_link);
             updater.setLinkPrev(current_link, prev_link);
         }
+        if(i==0) head_link = current_link;
+        // for the next iteration, the previous link is set as the current link
         prev_link = current_link;
     }
 

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.16"
+  "version": "1.1.17"
 }