@veritree/services 1.0.0-6 → 1.0.0-9

package/index.js

@@ -6,15 +6,17 @@ import { ForestTypeSpecies } from './src/endpoints/forest-type-species';
 import { ForestTypes } from './src/endpoints/forest-types';
 import { ForestTypeProfiles } from './src/endpoints/forest-types-profiles';
 import { Images } from './src/endpoints/images';
-import { User } from './src/endpoints/user';
 import { Orgs } from './src/endpoints/orgs';
+import { Notes } from './src/endpoints/notes';
 import { Regions } from './src/endpoints/regions';
+import { SDGs } from './src/endpoints/sdgs';
 import { Sponsors } from './src/endpoints/sponsors';
 import { Stats } from './src/endpoints/stats';
 import { Subdomains } from './src/endpoints/subdomains';
 import { Subsites } from './src/endpoints/subsites';
 import { SubsiteTypes } from './src/endpoints/subsite-types';
 import { TreeOrders } from './src/endpoints/trees-orders';
+import { User } from './src/endpoints/user';
 
 export {
   Countries,
@@ -24,14 +26,16 @@ export {
   ForestTypes,
   ForestTypeProfiles,
   FormSubmissions,
-  Orgs,
   Images,
-  User,
+  Orgs,
+  Notes,
   Regions,
+  SDGs,
   Sponsors,
   Stats,
   Subdomains,
   Subsites,
   SubsiteTypes,
-  TreeOrders
+  TreeOrders,
+  User
 }

package/package.json

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

package/src/endpoints/notes.js

@@ -0,0 +1,15 @@
+import Api from "../helpers/api";
+
+class NotesApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "notes";
+  }
+
+  async relation(prefix, id, args) {
+    const url = `${this.baseUrl}/${prefix}/${id}/${this.resource}${this.getUrlParams(args)}`;
+    return await this.unWrap(url);
+  }
+}
+
+export const Notes = new NotesApi();

package/src/endpoints/sdgs.js

@@ -0,0 +1,5 @@
+import Api from "../helpers/api";
+
+const resource = "sdgs";
+
+export const SDGs = new Api(resource);

package/src/helpers/api.js

@@ -8,7 +8,7 @@ import { getSession } from "./session";
  * @param {string} url
  * @returns {string} url
  */
-function handleEnvelopParam(url) {
+function addEnvelopeParam(url) {
   if (!url || url.includes("_result=1")) return url;
 
   const urlHasArgs = url.includes("?");
@@ -17,10 +17,50 @@ function handleEnvelopParam(url) {
   return `${url}${urlEvenlopeArg}`;
 }
 
+/**
+ * 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 !== undefined;
+  const isFormData = data instanceof FormData;
+  const accessToken = `Bearer ${getCookie("access_token")}`;
+
+  const config = {
+    method,
+    headers: {
+      Authorization: accessToken,
+    },
+  };
+
+  if (!isFormData) {
+    config.headers["Content-Type"] = "application/json";
+  }
+
+  // TODO: improve this ifs and elses
+  if (!isGet) {
+    if (!data) data = {};
+
+    if (isFormData) {
+      if (isSpoofing) data.set("_method", as.toUpperCase());
+      config.body = data;
+    } else {
+      if (isSpoofing) data._method = as.toUpperCase();
+      config.body = JSON.stringify(data);
+    }
+  }
+
+  return config;
+}
+
 export default class Api {
   constructor(resource) {
     this.baseUrl = `${process.env.API_VERITREE_URL}/api`;
-    this.resource = resource;
+    this.resource = resource ? resource : "";
     this.orgId = null;
     this.orgType = null;
   }
@@ -29,18 +69,19 @@ export default class Api {
    *
    * @returns {promise}
    */
-  async all() {
-    const url = `${this.getUrl()}${this.getUrlParams(arguments)}`;
+  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) {
-    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
+  async single(id, args) {
+    const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.get(url);
   }
 
@@ -61,10 +102,22 @@ export default class Api {
    * @returns {promise}
    */
   async update(id, data, as = "put") {
-    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
+    const url = `${this.getUrl(id)}${this.getUrlParams()}`;
     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) {
+    const url = `${this.getUrl(id)}${this.getUrlParams()}`;
+    return await this.post(url, null, "delete");
+  }
+
   /**
    *
    * @param {string} url
@@ -87,10 +140,21 @@ export default class Api {
 
   // ----------
   // --
-  getUrl() {
-    return `${this.baseUrl}/${this.resource}`;
+  /**
+   *
+   * @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;
@@ -103,11 +167,11 @@ export default class Api {
     }
 
     if (!isOrgLess) {
-      if (this.orgId) orgIdParam = `&org_id=${this.orgId}`;
+      if (this.orgId) orgIdParam = `org_id=${this.orgId}`;
       if (this.orgType) orgTypeParam = `&org_type=${this.orgType}`;
     }
 
-    return `?${orgIdParam}&${orgTypeParam}${createParamsStringFromArgs(args)}`;
+    return `?${orgIdParam}${orgTypeParam}${createParamsStringFromArgs(args)}`;
   }
 
   /**
@@ -119,55 +183,20 @@ export default class Api {
    * @returns {object} envelope
    */
   async unWrap(url, method = "get", data, as) {
-    url = handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
-    const config = this.getConfig(method, data, as);
-
-    try {
-      const response = await fetch(url, config);
-      const envelope = await response.json();
-
-      return envelope;
-    } catch (err) {
-      throw new Error(err);
-    }
-  }
-
-  /**
-   * Handles how the data should be sent in the fetch method
-   *
-   * @param {string} method
-   * @param {object} body
-   * @returns {object} data
-   */
-  getConfig(method, data, as) {
-    const isGet = method === "get";
-    const isPut = as === "put";
-    const isFormData = data instanceof FormData;
-    const accessToken = `Bearer ${getCookie("access_token")}`;
-
-    const config = {
-      method,
-      headers: {
-        Authorization: accessToken,
-      },
-    };
-
-    if (!isFormData) {
-      config.headers["Content-Type"] = "application/json";
-    }
-
-    // TODO: improve this ifs and elses
-    if (!isGet) {
-      if (isFormData) {
-        if (isPut) data.set("_method", "PUT");
-        config.body = data;
-      } else {
-        if (isPut) data._method = "PUT";
-        config.body = JSON.stringify(data);
+    url = addEnvelopeParam(url);
+    const config = getConfig(method, data, as);
+    const response = await fetch(url, config);
+
+    return new Promise((resolve, reject) => {
+      if (response.ok && response.status === 204) {
+        resolve();
+        return;
       }
-    }
 
-    return config;
+      response.json().then((json) => {
+        response.ok ? resolve(json) : reject(json);
+      });
+    });
   }
 
   setOrg() {

package/src/utils/args.js

@@ -1,32 +1,27 @@
 export const createParamsStringFromArgs = (args) => {
-  if(!args) return '';
+  if (!args && typeof args !== 'object' && !Array.isArray(args)) {
+    return "";
+  }
 
   const paramsString = [];
   let arr = [];
 
-  for(const arg of args) {
-    if(typeof arg === 'object') {
-      for(const key in arg) {
-        if(arg[key] === null) return;
-
-        if(Array.isArray(arg[key])) {
-          arr = arg[key].map((item, index) => {
-            const param = `${key}[]=${item}`;
+  Object.entries(args).forEach(([key, value]) => {
+    if (value === null) return;
 
-            return index === 0 ? `${param}` : `&${param}`;
-          }).join('');
+    if (Array.isArray(value)) {
+      arr = value.map((item, index) => {
+          const param = `${key}[]=${item}`;
+          return index === 0 ? `${param}` : `&${param}`;
+        }).join("");
 
-          paramsString.push(arr);
-        } else {
-          if(arg[key] !== undefined) {
-            paramsString.push(`${key}=${arg[key]}`);
-          }
-        }
+      paramsString.push(arr);
+    } else {
+      if (value !== undefined) {
+        paramsString.push(`${key}=${value}`);
       }
     }
-  }
-
-  if(!paramsString.length) return '';
+  });
 
-  return `&${paramsString.join('&')}`;
-}
+  return paramsString.length ? `&${paramsString.join("&")}` : "";
+};