@veritree/services 1.0.0-4 → 1.0.0-7

package/index.js

@@ -1,20 +1,21 @@
-import { Countries } from './src/services/countries';
-import { FieldUpdates } from './src/services/field-updates';
-import { FieldUpdateVerifications } from './src/services/field-udpate-verifications';
-import { FormSubmissions } from './src/services/form-submissions';
-import { ForestTypeSpecies } from './src/services/forest-type-species';
-import { ForestTypes } from './src/services/forest-types';
-import { ForestTypeProfiles } from './src/services/forest-types-profiles';
-import { Images } from './src/services/images';
-import { User } from './src/services/user';
-import { Orgs } from './src/services/orgs';
-import { Regions } from './src/services/regions';
-import { Sponsors } from './src/services/sponsors';
-import { Stats } from './src/services/stats';
-import { Subdomains } from './src/services/subdomains';
-import { Subsites } from './src/services/subsites';
-import { SubsiteTypes } from './src/services/subsite-types';
-import { TreeOrders } from './src/services/trees-orders';
+import { Countries } from './src/endpoints/countries';
+import { FieldUpdates } from './src/endpoints/field-updates';
+import { FieldUpdateVerifications } from './src/endpoints/field-udpate-verifications';
+import { FormSubmissions } from './src/endpoints/form-submissions';
+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 { 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';
 
 export {
   Countries,
@@ -28,6 +29,7 @@ export {
   Images,
   User,
   Regions,
+  SDGs,
   Sponsors,
   Stats,
   Subdomains,

package/package.json

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

package/src/{services → endpoints}/orgs.js

@@ -1,9 +1,9 @@
-import Api from '../helpers/api';
+import Api from "../helpers/api";
 
 class OrgsApi extends Api {
   constructor(resource) {
     super(resource);
-    this.resource = 'orgs';
+    this.resource = "orgs";
   }
 
   async stats() {
@@ -16,8 +16,8 @@ class OrgsApi extends Api {
     return await this.get(url);
   }
 
-  _geStatstUrl = (isPublic) => {
-    const endpoint = isPublic ? 'pstats' : 'stats';
+  _geStatstUrl(isPublic) {
+    const endpoint = isPublic ? "pstats" : "stats";
     return `${this.getUrl()}/${endpoint}${this.getUrlParams()}`;
   }
 }

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/{services → endpoints}/trees-orders.js

@@ -1,5 +1,6 @@
 import Api from '../helpers/api';
 
 const resource = 'tree-orders';
+
 export const TreeOrders = new Api(resource);
 

package/src/helpers/api.js

@@ -2,6 +2,59 @@ import { getCookie } from "./cookies";
 import { createParamsStringFromArgs } from "../utils/args";
 import { getSession } from "./session";
 
+/**
+ * Adds the envelope argument to the url
+ *
+ * @param {string} url
+ * @returns {string} url
+ */
+function handleEnvelopParam(url) {
+  if (!url || url.includes("_result=1")) return url;
+
+  const urlHasArgs = url.includes("?");
+  const urlEvenlopeArg = urlHasArgs ? "&_result=1" : "?_result=1";
+
+  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 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);
+    }
+  }
+
+  return config;
+}
+
 export default class Api {
   constructor(resource) {
     this.baseUrl = `${process.env.API_VERITREE_URL}/api`;
@@ -14,18 +67,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);
   }
 
@@ -46,7 +100,7 @@ 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);
   }
 
@@ -55,9 +109,9 @@ export default class Api {
    * @param {string} url
    * @returns {promise}
    */
-  get = async function (url) {
+  async get(url) {
     return await this.unWrap(url);
-  };
+  }
 
   /**
    *
@@ -65,27 +119,46 @@ export default class Api {
    * @param {object} data
    * @returns {promise}
    */
-  post = async function (url, data, as) {
+  async post(url, data, as) {
     if (!url) url = `${this.getUrl()}${this.getUrlParams()}`;
     return await this.unWrap(url, "post", data, as);
-  };
+  }
 
   // ----------
   // --
-  getUrl = () => {
-    return `${this.baseUrl}/${this.resource}`;
-  };
+  /**
+   *
+   * @param {string, number} id
+   * @returns
+   */
+  getUrl(id) {
+    id = id ? `/${id}` : "";
+    return `${this.baseUrl}/${this.resource}${id}`;
+  }
 
-  getUrlParams = (args) => {
+  /**
+   *
+   * @param {object} args
+   * @returns {string}
+   */
+  getUrlParams(args) {
     this.setOrg();
+    let isOrgLess = false;
+    let orgIdParam = "";
+    let orgTypeParam = "";
+
+    // while most of endpoints require an org id and type, some endpoints do not
+    if (args && args.length) {
+      isOrgLess = Object.hasOwnProperty.call(...args, "orgless");
+    }
 
-    const orgIdParam = this.orgId ? `org_id=${this.orgId}` : "";
-    const orgTypeParam = this.orgType ? `org_type=${this.orgType}` : "";
+    if (!isOrgLess) {
+      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)}`;
+  }
 
   /**
    * Deals with all fetch requests
@@ -95,9 +168,9 @@ export default class Api {
    * @param {object} data
    * @returns {object} envelope
    */
-  unWrap = async function (url, method = "get", data, as) {
-    url = this.handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
-    const config = this.getConfig(method, data, as);
+  async unWrap(url, method = "get", data, as) {
+    url = handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
+    const config = getConfig(method, data, as);
 
     try {
       const response = await fetch(url, config);
@@ -107,68 +180,13 @@ export default class Api {
     } 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 = function (method, data, as) {
-    const isGet = method === "get";
-    const isPut = as === "put";
-    const isFormData = this.isFormData(data);
-    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);
-      }
-    }
-
-    return config;
-  };
+  }
 
-  setOrg = () => {
+  setOrg() {
     const session = getSession();
-    if(!session) return;
+    if (!session) return;
     const { orgId, orgType } = session;
     this.orgId = orgId;
     this.orgType = orgType;
   }
-
-  /**
-   * Adds the envelope argument to the url
-   *
-   * @param {string} url
-   * @returns {string} url
-   */
-  handleEnvelopParam = function (url) {
-    if (!url || url.includes("_result=1")) return url;
-
-    const urlHasArgs = url.includes("?");
-    const urlEvenlopeArg = urlHasArgs ? "&_result=1" : "?_result=1";
-
-    return `${url}${urlEvenlopeArg}`;
-  };
-
-  isFormData = (data) => data instanceof FormData;
 }

package/src/helpers/session.js

@@ -1,7 +1,3 @@
-export const getSessionOrgId = () => {
-  return getSession().orgId;
-};
-
 export const getSession = () => {
   return JSON.parse(localStorage.getItem('session'));
 };

package/src/utils/args.js

@@ -1,32 +1,28 @@
 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('&')}`;
-}
+  if (!paramsString.length) return "";
+  return `&${paramsString.join("&")}`;
+};