@veritree/services 1.0.0-7 → 1.0.0

package/index.js

@@ -6,8 +6,8 @@ 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';
@@ -15,7 +15,9 @@ 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 { Tags } from './src/endpoints/tags';
 import { TreeOrders } from './src/endpoints/trees-orders';
+import { User } from './src/endpoints/user';
 
 export {
   Countries,
@@ -25,9 +27,9 @@ export {
   ForestTypes,
   ForestTypeProfiles,
   FormSubmissions,
-  Orgs,
   Images,
-  User,
+  Orgs,
+  Notes,
   Regions,
   SDGs,
   Sponsors,
@@ -35,5 +37,7 @@ export {
   Subdomains,
   Subsites,
   SubsiteTypes,
-  TreeOrders
+  Tags,
+  TreeOrders,
+  User
 }

package/package.json

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

package/src/endpoints/forest-types.js

@@ -1,5 +1,15 @@
 import Api from "../helpers/api";
+import Sequestrations from '../helpers/sequestrations';
 
-const resource = "forest-types";
+class ForestTypesApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "forest-types";
+  }
 
-export const ForestTypes = new Api(resource);
+  sequestrations(id, args) {
+    return Sequestrations(this, id, args);
+  }
+}
+
+export const ForestTypes = new ForestTypesApi();

package/src/endpoints/notes.js

@@ -0,0 +1,15 @@
+import Api from "../helpers/api";
+import Relations from "../helpers/relations";
+
+class NotesApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "notes";
+  }
+
+  relation(prefix, id, args) {
+    return Relations(this, prefix, id, args);
+  }
+}
+
+export const Notes = new NotesApi();

package/src/endpoints/sponsors.js

@@ -23,6 +23,17 @@ class SponsorsApi extends Api {
     const url = `${this.getUrl()}/${this.orgId}/profile`;
     return await this.get(url);
   }
+
+  async plantingStats(args) {
+    const url = `${this.getUrl()}/planting-stats${this.getUrlParams(args)}`;
+    return await this.get(url);
+  }
+
+  async totalPlantingStats() {
+    const url = `${this.getUrl()}/total-planting-stats`;
+    return await this.get(url);
+  }  
+
 }
 
 export const Sponsors = new SponsorsApi();

package/src/endpoints/tags.js

@@ -0,0 +1,15 @@
+import Api from "../helpers/api";
+import Relations from "../helpers/relations";
+
+class TagsApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "tags";
+  }
+
+  relation(prefix, id, args) {
+    return Relations(this, prefix, id, args);
+  }
+}
+
+export const Tags = new TagsApi();

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("?");
@@ -26,7 +26,7 @@ function handleEnvelopParam(url) {
  */
 function getConfig(method, data, as) {
   const isGet = method === "get";
-  const isPut = as === "put";
+  const isSpoofing = as !== undefined;
   const isFormData = data instanceof FormData;
   const accessToken = `Bearer ${getCookie("access_token")}`;
 
@@ -43,11 +43,13 @@ function getConfig(method, data, as) {
 
   // TODO: improve this ifs and elses
   if (!isGet) {
+    if (!data) data = {};
+
     if (isFormData) {
-      if (isPut) data.set("_method", "PUT");
+      if (isSpoofing) data.set("_method", as.toUpperCase());
       config.body = data;
     } else {
-      if (isPut) data._method = "PUT";
+      if (isSpoofing) data._method = as.toUpperCase();
       config.body = JSON.stringify(data);
     }
   }
@@ -58,7 +60,7 @@ function getConfig(method, data, as) {
 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;
   }
@@ -104,6 +106,18 @@ export default class Api {
     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
@@ -153,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)}`;
   }
 
   /**
@@ -169,17 +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
+    url = addEnvelopeParam(url);
     const config = getConfig(method, data, as);
-
-    try {
-      const response = await fetch(url, config);
-      const envelope = await response.json();
-
-      return envelope;
-    } catch (err) {
-      throw new Error(err);
-    }
+    const response = await fetch(url, config);
+
+    return new Promise((resolve, reject) => {
+      if (response.ok && response.status === 204) {
+        resolve();
+        return;
+      }
+
+      response.json().then((json) => {
+        response.ok ? resolve(json) : reject(json);
+      });
+    });
   }
 
   setOrg() {

package/src/helpers/relations.js

@@ -0,0 +1,32 @@
+const Relations = (api, prefix, id, args) => {
+  let url = `${api.baseUrl}/${prefix}/${id}/${api.resource}`;
+  
+  const all = async () => {
+    url = `${url}${api.getUrlParams(args)}`;
+    return await api.get(url);
+  }
+
+  const single = async(tagId) => {
+    url = `${url}/${tagId}${api.getUrlParams(args)}`;
+    return await api.get(url);
+  }
+
+  const attach = async(tagId, data) => {
+    url = `${url}/${tagId}/attach${api.getUrlParams(args)}`;
+    return await api.post(url, data);
+  }
+
+  const detach = async(tagId, data) => {
+    url = `${url}/${tagId}/detach${api.getUrlParams(args)}`;
+    return await api.delete(url, data);
+  }
+
+  return {
+    all,
+    single,
+    attach,
+    detach
+  }
+}
+
+export default Relations;

package/src/helpers/sequestrations.js

@@ -0,0 +1,20 @@
+const Sequestrations = (api, forestTypeId, args) => {
+  let url = `${api.baseUrl}/${api.resource}/${forestTypeId}/sequestrations`;
+
+  const all = async () => {
+    url = `${url}${api.getUrlParams(args)}`;
+    return await api.get(url);
+  }
+
+  const create = async(data) => {
+    url = `${url}${api.getUrlParams(args)}`;
+    return await api.post(url, data);
+  }
+
+  return {
+    all,
+    create
+  }
+}
+
+export default Sequestrations;

package/src/utils/args.js

@@ -23,6 +23,5 @@ export const createParamsStringFromArgs = (args) => {
     }
   });
 
-  if (!paramsString.length) return "";
-  return `&${paramsString.join("&")}`;
+  return paramsString.length ? `&${paramsString.join("&")}` : "";
 };