@veritree/services 1.0.0-3 → 1.0.0-6

package/index.js

@@ -1,20 +1,20 @@
-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 { 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,

package/package.json

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

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

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "countries";
 

package/src/{services → endpoints}/field-udpate-verifications.js

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "field-update-verifications";
 

package/src/{services → endpoints}/field-updates.js

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "field-updates";
 

package/src/endpoints/forest-type-species.js

@@ -0,0 +1,5 @@
+import Api from "../helpers/api";
+
+const resource = "forest-type-species";
+
+export const ForestTypeSpecies = new Api(resource);

package/src/endpoints/forest-types-profiles.js

@@ -0,0 +1,5 @@
+import Api from '../helpers/api';
+
+const resource = 'forest-type-profiles';
+
+export const ForestTypeProfiles = new Api(resource);

package/src/endpoints/forest-types.js

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

package/src/endpoints/form-submissions.js

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

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

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "images";
 

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

@@ -1,9 +1,9 @@
-import Api from '../helpers/api-v2';
+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/{services → endpoints}/regions.js

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "regions";
 

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

@@ -1,4 +1,4 @@
-import Api from '../helpers/api-v2';
+import Api from '../helpers/api';
 
 class SponsorsApi extends Api {
   constructor(resource) {

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

@@ -1,4 +1,4 @@
-import Api from '../helpers/api-v2';
+import Api from '../helpers/api';
 
 class StatsApi extends Api {
   constructor(resource) {

package/src/endpoints/subdomains.js

@@ -0,0 +1,5 @@
+import Api from '../helpers/api';
+
+const resource = 'subdomains';
+
+export const Subdomains = new Api(resource);

package/src/{services → endpoints}/subsite-types.js

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "subsite-types";
 

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

@@ -1,4 +1,4 @@
-import Api from "../helpers/api-v2";
+import Api from "../helpers/api";
 
 const resource = "subsites";
 

package/src/{services → endpoints}/trees-orders.js

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

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

@@ -1,4 +1,4 @@
-import Api from '../helpers/api-v2';
+import Api from '../helpers/api';
 
 class UserApi extends Api {
   constructor(resource) {

package/src/helpers/api.js

@@ -1,38 +1,114 @@
 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}`;
+}
+
+export default class Api {
+  constructor(resource) {
+    this.baseUrl = `${process.env.API_VERITREE_URL}/api`;
+    this.resource = resource;
+    this.orgId = null;
+    this.orgType = null;
+  }
 
-const Api = {
-  baseUrl: `${process.env.API_VERITREE_URL}/api`,
-  forceEnvelopeResponse: true, // TODO: remove when API is fully migrated to envelopes
+  /**
+   *
+   * @returns {promise}
+   */
+  async all() {
+    const url = `${this.getUrl()}${this.getUrlParams(arguments)}`;
+    return await this.get(url);
+  }
 
   /**
-   * 
-   * @param {string} url 
+   *
+   * @param {string, number} id
    * @returns {promise}
    */
-  async get(url) {
-    return await this.unWrap(url);
-  },
+  async single(id) {
+    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
+    return await this.get(url);
+  }
 
   /**
-   * 
-   * @param {string} url 
-   * @param {object} data 
+   *
+   * @param {object} data
    * @returns {promise}
    */
-  async post(url, data, as) {
-    return await this.unWrap(url, "post", data, as);
-  },
+  async create(data) {
+    return await this.post(null, data);
+  }
 
   /**
-   * 
-   * @param {string} url 
-   * @param {object} data 
+   *
+   * @param {string} url
+   * @param {object} data
    * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
    * @returns {promise}
    */
-  async update(url, data, as = "put") {
+  async update(id, data, as = "put") {
+    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
     return await this.post(url, data, as);
-  },
+  }
+
+  /**
+   *
+   * @param {string} url
+   * @returns {promise}
+   */
+  async get(url) {
+    return await this.unWrap(url);
+  }
+
+  /**
+   *
+   * @param {string} url
+   * @param {object} data
+   * @returns {promise}
+   */
+  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}`;
+  }
+
+  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");
+    }
+
+    if (!isOrgLess) {
+      if (this.orgId) orgIdParam = `&org_id=${this.orgId}`;
+      if (this.orgType) orgTypeParam = `&org_type=${this.orgType}`;
+    }
+
+    return `?${orgIdParam}&${orgTypeParam}${createParamsStringFromArgs(args)}`;
+  }
 
   /**
    * Deals with all fetch requests
@@ -43,7 +119,7 @@ const Api = {
    * @returns {object} envelope
    */
   async unWrap(url, method = "get", data, as) {
-    if (this.forceEnvelopeResponse) url = this.handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
+    url = handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
     const config = this.getConfig(method, data, as);
 
     try {
@@ -54,7 +130,7 @@ const Api = {
     } catch (err) {
       throw new Error(err);
     }
-  },
+  }
 
   /**
    * Handles how the data should be sent in the fetch method
@@ -66,8 +142,8 @@ const Api = {
   getConfig(method, data, as) {
     const isGet = method === "get";
     const isPut = as === "put";
-    const isFormData = this._isFormData(data);
-    const accessToken = `Bearer ${getCookie('access_token')}`;
+    const isFormData = data instanceof FormData;
+    const accessToken = `Bearer ${getCookie("access_token")}`;
 
     const config = {
       method,
@@ -76,42 +152,29 @@ const Api = {
       },
     };
 
-    if(!isFormData) {
-      config.headers['Content-Type'] = 'application/json';
+    if (!isFormData) {
+      config.headers["Content-Type"] = "application/json";
     }
 
     // TODO: improve this ifs and elses
     if (!isGet) {
-      if(isFormData) {
-        if(isPut) data.set('_method', 'PUT');
+      if (isFormData) {
+        if (isPut) data.set("_method", "PUT");
         config.body = data;
       } else {
-        if(isPut) data._method = 'PUT';
+        if (isPut) data._method = "PUT";
         config.body = JSON.stringify(data);
       }
     }
 
     return config;
-  },
-
-  /**
-   * Adds the envelope argument to the url
-   *
-   * @param {string} url
-   * @returns {string} url
-   */
-  handleEnvelopParam(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) {
-    return data instanceof FormData;
-  },
-};
-
-export default Api;
+  }
+
+  setOrg() {
+    const session = getSession();
+    if (!session) return;
+    const { orgId, orgType } = session;
+    this.orgId = orgId;
+    this.orgType = orgType;
+  }
+}

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/helpers/api-v2.js

@@ -1,174 +0,0 @@
-import { getCookie } from "./cookies";
-import { createParamsStringFromArgs } from "../utils/args";
-import { getSession } from "./session";
-
-export default class Api {
-  constructor(resource) {
-    this.baseUrl = `${process.env.API_VERITREE_URL}/api`;
-    this.resource = resource;
-    this.orgId = null;
-    this.orgType = null;
-  }
-
-  /**
-   *
-   * @returns {promise}
-   */
-  async all() {
-    const url = `${this.getUrl()}${this.getUrlParams(arguments)}`;
-    return await this.get(url);
-  }
-
-  /**
-   *
-   * @param {string, number} id
-   * @returns {promise}
-   */
-  async single(id) {
-    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
-    return await this.get(url);
-  }
-
-  /**
-   *
-   * @param {object} data
-   * @returns {promise}
-   */
-  async create(data) {
-    return await this.post(null, data);
-  }
-
-  /**
-   *
-   * @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") {
-    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
-    return await this.post(url, data, as);
-  }
-
-  /**
-   *
-   * @param {string} url
-   * @returns {promise}
-   */
-  get = async function (url) {
-    return await this.unWrap(url);
-  };
-
-  /**
-   *
-   * @param {string} url
-   * @param {object} data
-   * @returns {promise}
-   */
-  post = async function (url, data, as) {
-    if (!url) url = `${this.getUrl()}${this.getUrlParams()}`;
-    return await this.unWrap(url, "post", data, as);
-  };
-
-  // ----------
-  // --
-  getUrl = () => {
-    return `${this.baseUrl}/${this.resource}`;
-  };
-
-  getUrlParams = (args) => {
-    this.setOrg();
-
-    const orgIdParam = this.orgId ? `org_id=${this.orgId}` : "";
-    const orgTypeParam = this.orgType ? `org_type=${this.orgType}` : "";
-
-    return `?${orgIdParam}&${orgTypeParam}${createParamsStringFromArgs(
-      args
-    )}`;
-  };
-
-  /**
-   * Deals with all fetch requests
-   *
-   * @param {string} url
-   * @param {string} method
-   * @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);
-
-    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 = 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 = () => {
-    const session = getSession();
-    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/services/forest-type-species.js

@@ -1,5 +0,0 @@
-import Api from "../helpers/api-v2";
-
-const resource = "forest-type-species";
-
-export const ForestTypeSpecies = new Api(resource);

package/src/services/forest-types-profiles.js

@@ -1,5 +0,0 @@
-import Api from '../helpers/api-v2';
-
-const resource = 'forest-type-profiles';
-
-export const ForestTypeProfiles = new Api(resource);

package/src/services/forest-types.js

@@ -1,5 +0,0 @@
-import Api from "../helpers/api-v2";
-
-const resource = "forest-types";
-
-export const ForestTypes = new Api(resource);

package/src/services/form-submissions.js

@@ -1,5 +0,0 @@
-import Api from "../helpers/api-v2";
-
-const resource = "form-submissions";
-
-export const FormSubmissions = new Api(resource);

package/src/services/subdomains.js

@@ -1,5 +0,0 @@
-import Api from '../helpers/api-v2';
-
-const resource = 'subdomains';
-
-export const Subdomains = new Api(resource);