@veritree/services 2.30.1-1 → 2.31.0

package/index.js

@@ -37,6 +37,7 @@ import { Organizations } from './src/endpoints/organizations';
 import { Tasks } from './src/endpoints/tasks';
 import { Geometries } from './src/endpoints/geometries';
 import { Password } from './src/endpoints/password';
+import { TreeCodes } from './src/endpoints/tree-codes';
 
 export {
   BulkUploads,
@@ -77,5 +78,6 @@ export {
   Organizations,
   Tasks,
   Geometries,
-  Password
+  Password,
+  TreeCodes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veritree/services",
-  "version": "2.30.1-1",
+  "version": "2.31.0",
   "description": "A collection of javascript functions/services to talk to veritree API",
   "type": "module",
   "main": "index.js",

package/src/endpoints/password.js

@@ -1,10 +1,10 @@
 import Api from "../helpers/api";
 
 /**
- * This is a namespace that contains documentation elements 
- * belonging to the Password domain.
- *
- * @namespace Password
+ * This is a namespace that contains documentation elements belonging to the Password domain.
+ * 
+ * @class
+ * @module Password
  */
 class PasswordApi extends Api {
   constructor(resource) {
@@ -12,6 +12,11 @@ class PasswordApi extends Api {
     this.resource = "password";
   }
 
+  /**
+   * @function
+   * @name recovery
+   * @returns {Object}
+   */
   recovery() {
     /**
      * Sends a recovery password email to the specified email address.
@@ -32,6 +37,11 @@ class PasswordApi extends Api {
     };
   }
 
+  /**
+   * @function
+   * @name reset
+   * @returns {Object}
+   */
   reset() {
     /**
      * Sends a POST request to reset a password with the specified email, token, and password.
@@ -44,7 +54,7 @@ class PasswordApi extends Api {
      * @returns {Promise<Object>} - A Promise that resolves to the result of the POST request.
      */
     const post = async (data) => {
-      const url = `${this.getUrl()}/reset`
+      const url = `${this.getUrl()}/reset`;
 
       return await this.post(url, data);
     };
@@ -55,4 +65,4 @@ class PasswordApi extends Api {
   }
 }
 
-export const Password = new PasswordApi();
+export const Password = new PasswordApi();

package/src/endpoints/tree-codes.js

@@ -0,0 +1,21 @@
+import Api from "../helpers/api";
+
+class TreeCodesApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "tree-codes";
+  }
+
+  holders(args) {
+    const claim = async (treeCodeHolder) => {
+      const url = `${this.getUrl()}/holders/claim/${treeCodeHolder}${this.getUrlParams(args)}`;
+      return await this.get(url);
+    };
+
+    return {
+      claim,
+    };
+  }
+}
+
+export const TreeCodes = new TreeCodesApi();

package/src/helpers/api.js

@@ -23,13 +23,7 @@ function addVersionParam(url) {
   return `${url}${urlVersionParam}`;
 }
 
-/**
- * Handles how the data should be sent in the fetch method
- *
- * @param {string} method
- * @param {object} body
- * @returns {object} data
- */
+
 function getConfig(method, data, as) {
   const isGet = method === "get";
   const isSpoofing = as;
@@ -75,96 +69,45 @@ export default class Api {
     this.baseUrl = baseUrl;
   }
 
-  /**
-   *
-   * @returns {promise}
-   */
   async all(args) {
     const url = `${this.getUrl()}${this.getUrlParams(args)}`;
     return await this.get(url);
   }
 
-  /**
-   *
-   * @param {string, number} id
-   * @param {object} args/params
-   * @returns {promise}
-   */
   async single(id, args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.get(url);
   }
 
-  /**
-   *
-   * @param {object} data
-   * @returns {promise}
-   */
   async create(data, args) {
     return await this.post(null, data, null, args);
   }
 
-  /**
-   *
-   * @param {string} url
-   * @param {object} data
-   * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
-   * @returns {promise}
-   */
   async update(id, data, as = "put", args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.post(url, data, as);
   }
 
-  /**
-   *
-   * @param {string} url
-   * @param {object} data
-   * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
-   * @returns {promise}
-   */
   async delete(id, args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.post(url, null, "delete");
   }
 
-  /**
-   *
-   * @param {string} url
-   * @returns {promise}
-   */
   async get(url) {
+    console.log(url);
     return await this.unWrap(url);
   }
 
-  /**
-   *
-   * @param {string} url
-   * @param {object} data
-   * @returns {promise}
-   */
   async post(url, data, as, args) {
     if (!url) url = `${this.getUrl()}${this.getUrlParams(args)}`;
     return await this.unWrap(url, "post", data, as);
   }
 
-  // ----------
-  // --
-  /**
-   *
-   * @param {string, number} id
-   * @returns
-   */
   getUrl(id) {
     id = id ? `/${id}` : "";
     return `${this.baseUrl}/${this.resource}${id}`;
   }
 
-  /**
-   *
-   * @param {object} args
-   * @returns {string}
-   */
   getUrlParams(args) {
     this.setOrg();
     let isOrgLess = false;
@@ -209,14 +152,6 @@ export default class Api {
     )}`;
   }
 
-  /**
-   * Deals with all fetch requests
-   *
-   * @param {string} url
-   * @param {string} method
-   * @param {object} data
-   * @returns {object} envelope
-   */
   async unWrap(url, method = "get", data, as) {
     url = addVersionParam(url);
     const config = getConfig(method, data, as);