@veritree/services 0.15.0 → 1.0.0-0

package/index.js

@@ -1,29 +1,45 @@
 import { createCountriesApiService } from './src/services/countries.js';
+import { Countries } from './src/services/countries2.js';
 import { createFieldUpdatesApiService } from './src/services/field-updates.js';
 import { createFieldUpdateVerificationsApiService } from './src/services/field-udpate-verifications.js';
 import { createFormSubmissionsApiService } from './src/services/form-submissions.js';
+import { createForestTypeSpeciesApiService } from './src/services/forest-type-species.js';
+import { ForestTypeSpecies } from './src/services/forest-type-species2.js';
 import { createForestTypesApiService } from './src/services/forest-types.js';
+import { ForestTypes } from './src/services/forest-types2.js';
 import { createImagesApiService } from './src/services/images.js';
+import { Images } from './src/services/images2.js';
 import { createMeApiService } from './src/services/me.js';
 import { createOrgsApiService } from './src/services/orgs.js';
 import { createRegionsApiService } from './src/services/regions.js';
+import { Regions } from './src/services/regions2.js';
 import { createSponsorsApiService } from './src/services/sponsors.js';
 import { createSubdomainsApiService } from './src/services/subdomains.js';
 import { createSubsitesApiService } from './src/services/subsites.js';
+import { Subsites } from './src/services/subsites2.js';
+import { createSubsiteTypesApiService } from './src/services/subsite-types.js';
 import { createTreeOrdersApiService } from './src/services/trees-orders.js';
 
 export {
   createCountriesApiService,
+  Countries,
   createFieldUpdatesApiService,
   createFieldUpdateVerificationsApiService,
+  createForestTypeSpeciesApiService,
+  ForestTypeSpecies,
   createForestTypesApiService,
+  ForestTypes,
   createFormSubmissionsApiService,
   createOrgsApiService,
   createImagesApiService,
+  Images,
   createMeApiService,
   createRegionsApiService,
+  Regions,
   createSponsorsApiService,
   createSubdomainsApiService,
   createSubsitesApiService,
+  Subsites,
+  createSubsiteTypesApiService,
   createTreeOrdersApiService,
 }

package/package.json

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

package/src/helpers/api-v2.js

@@ -0,0 +1,159 @@
+import { getCookie } from "./cookies";
+import { getSession } from "./session";
+import { createParamsStringFromArgs } from "../utils/args";
+
+export default function Api(resource) {
+  const baseUrl = `${process.env.API_VERITREE_URL}/api`;
+  const { orgId, orgType } = getSession();
+
+  if (!orgId && !orgType) {
+    throw new Error("Organization id and type are required");
+  }
+
+  /**
+   * 
+   * @returns {promise}
+   */
+  this.all = async function () {
+    const url = `${this.getUrl()}?${this.getUrlParams(arguments)}`;
+    return await this.get(url);
+  };
+
+  /**
+   * 
+   * @param {string, number} id 
+   * @returns {promise}
+   */
+  this.single = async function (id) {
+    const url = `${this.getUrl()}/${id}?${this.getUrlParams()}`;
+    return await this.get(url);
+  };
+
+  /**
+   * 
+   * @param {object} data 
+   * @returns {promise}
+   */
+  this.create = async function (data) {
+    const url = `${this.getUrl()}?${this.getUrlParams()}`;
+    return await this.post(url, data);
+  };
+
+  /**
+   *
+   * @param {string} url
+   * @param {object} data
+   * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
+   * @returns {promise}
+   */
+  this.update = async function (id, data, as = 'put') {
+    const url = `${this.getUrl()}/${id}?${this.getUrlParams()}`;
+    return await this.post(url, data, as);
+  };
+
+  // ----------
+  // --
+  this.getUrl = () => {
+    return `${baseUrl}/${resource}`;
+  }
+
+  this.getUrlParams = (args) => {
+    return `org_id=${orgId}&org_type=${orgType}${createParamsStringFromArgs(args)}`;
+  }
+
+  /**
+   *
+   * @param {string} url
+   * @returns {promise}
+   */
+  this.get = async function (url) {
+    return await this.unWrap(url);
+  };
+
+  /**
+   *
+   * @param {string} url
+   * @param {object} data
+   * @returns {promise}
+   */
+  this.post = async function (url, data, as) {
+    return await this.unWrap(url, "post", data, as);
+  };
+
+  /**
+   * Deals with all fetch requests
+   *
+   * @param {string} url
+   * @param {string} method
+   * @param {object} data
+   * @returns {object} envelope
+   */
+  this.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
+   */
+  this.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;
+  };
+
+  /**
+   * Adds the envelope argument to the url
+   *
+   * @param {string} url
+   * @returns {string} url
+   */
+  this.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}`;
+  };
+
+  this.isFormData = (data) => data instanceof FormData;
+}

package/src/helpers/api.js

@@ -4,16 +4,34 @@ const Api = {
   baseUrl: `${process.env.API_VERITREE_URL}/api`,
   forceEnvelopeResponse: true, // TODO: remove when API is fully migrated to envelopes
 
+  /**
+   * 
+   * @param {string} url 
+   * @returns {promise}
+   */
   async get(url) {
     return await this.unWrap(url);
   },
 
-  async post(url, data) {
-    return await this.unWrap(url, "post", data);
+  /**
+   * 
+   * @param {string} url 
+   * @param {object} data 
+   * @returns {promise}
+   */
+  async post(url, data, as) {
+    return await this.unWrap(url, "post", data, as);
   },
 
-  async update(url, data) {
-    return await this.unWrap(url, "put", 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") {
+    return await this.post(url, data, as);
   },
 
   /**
@@ -24,9 +42,9 @@ const Api = {
    * @param {object} data
    * @returns {object} envelope
    */
-  async unWrap(url, method = "get", data) {
+  async unWrap(url, method = "get", data, as) {
     if (this.forceEnvelopeResponse) url = this.handleEnvelopParam(url, data); // TODO: remove when API is fully migrated to envelopes
-    const config = this.getConfig(method, data);
+    const config = this.getConfig(method, data, as);
 
     try {
       const response = await fetch(url, config);
@@ -45,8 +63,9 @@ const Api = {
    * @param {object} body
    * @returns {object} data
    */
-  getConfig(method, data) {
+  getConfig(method, data, as) {
     const isGet = method === "get";
+    const isPut = as === "put";
     const isFormData = this._isFormData(data);
     const accessToken = `Bearer ${getCookie('access_token')}`;
 
@@ -61,8 +80,15 @@ const Api = {
       config.headers['Content-Type'] = 'application/json';
     }
 
+    // TODO: improve this ifs and elses
     if (!isGet) {
-      isFormData ? (config.body = data) : (config.body = JSON.stringify(data));
+      if(isFormData) {
+        if(isPut) data.set('_method', 'PUT');
+        config.body = data;
+      } else {
+        if(isPut) data._method = 'PUT';
+        config.body = JSON.stringify(data);
+      }
     }
 
     return config;

package/src/services/countries2.js

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

package/src/services/field-udpate-verifications.js

@@ -24,13 +24,8 @@ export const createFieldUpdateVerificationsApiService = () => {
     return `${Api.baseUrl}/${resource}`;
   };
 
-  const _getParams = (page, orderBy, pageSize) => {
-    const pageParam = page ? `&page=${page}` : "";
-    const orderByParam = orderBy ? `&orderBy=${orderBy}` : "";
-    const pageSizeParam = pageSize ? `&page_size=${pageSize}` : "";
-    const params = `${pageParam}${pageSizeParam}${orderByParam}`;
-
-    return `org_id=${orgId}&org_type=${orgType}${params}`;
+  const _getParams = () => {
+    return `org_id=${orgId}&org_type=${orgType}`;
   };
 
   return {

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

@@ -0,0 +1,63 @@
+import Api from "../helpers/api";
+import { createParamsStringFromArgs } from "../utils/args";
+import { getSession } from "../helpers/session";
+// import { all, getUrl, getUrlParams } from "../utils/methods";
+
+export const createForestTypeSpeciesApiService = () => {
+  const resource = "forest-type-species";
+  const { orgId, orgType } = getSession();
+
+  if (!orgId && !orgType) {
+    throw new Error("Organization id and type are required");
+  }
+
+  const get = {
+    /**
+     * @param {object} arguments
+     * @returns {object} envelope
+     */
+    async all() {
+      const url = `${_getUrl()}?${_getUrlParams(arguments)}`;
+
+      return await Api.get(url);
+    },
+
+    /**
+     * @param {number/string} id
+     * @returns {object} envelope
+     */
+    async specific(id) {
+      const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+      return await Api.get(url);
+    },
+  };
+
+  const post = (data) => {
+    const url = `${_getUrl()}?${_getUrlParams()}`;
+
+    return Api.post(url, data);
+  };
+
+  const update = (id, data) => {
+    const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+    return Api.update(url, data);
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getUrlParams = (args) => {
+    const paramsString = createParamsStringFromArgs(args);
+
+    return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
+  };
+
+  return {
+    get,
+    post,
+    update,
+  };
+};

package/src/services/forest-type-species2.js

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

package/src/services/forest-types.js

@@ -1,13 +1,13 @@
-import Api from '../helpers/api';
-import { createParamsStringFromArgs } from '../utils/args';
+import Api from "../helpers/api";
+import { createParamsStringFromArgs } from "../utils/args";
 import { getSession } from "../helpers/session";
 
 export const createForestTypesApiService = () => {
-  const resource = 'forest-types';
+  const resource = "forest-types";
   const { orgId, orgType } = getSession();
 
   if (!orgId && !orgType) {
-    throw new Error('Organization id and type are required');
+    throw new Error("Organization id and type are required");
   }
 
   const get = {
@@ -15,8 +15,8 @@ export const createForestTypesApiService = () => {
      * @param {object} arguments
      * @returns {object} envelope
      */
-     async all() {
-      const url = `${_getUrl()}?${_getParams(arguments)}`;
+    async all() {
+      const url = `${_getUrl()}?${_getUrlParams(arguments)}`;
 
       return await Api.get(url);
     },
@@ -26,17 +26,29 @@ export const createForestTypesApiService = () => {
      * @returns {object} envelope
      */
     async specific(id) {
-      const url = `${_getUrl()}/${id}?${_getParams()}`;
+      const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
 
       return await Api.get(url);
     },
   };
 
+  const post = (data) => {
+    const url = `${_getUrl()}?${_getUrlParams()}`;
+
+    return Api.post(url, data);
+  };
+
+  const update = (id, data) => {
+    const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+    return Api.update(url, data);
+  };
+
   const _getUrl = () => {
     return `${Api.baseUrl}/${resource}`;
   };
 
-  const _getParams = (args) => {
+  const _getUrlParams = (args) => {
     const paramsString = createParamsStringFromArgs(args);
 
     return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
@@ -44,5 +56,7 @@ export const createForestTypesApiService = () => {
 
   return {
     get,
+    post,
+    update,
   };
 };

package/src/services/forest-types2.js

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

package/src/services/images2.js

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

package/src/services/regions2.js

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

package/src/services/subsite-types.js

@@ -0,0 +1,70 @@
+import Api from "../helpers/api";
+import { getSession } from "../helpers/session";
+import { createParamsStringFromArgs } from "../utils/args";
+
+export const createSubsiteTypesApiService = () => {
+  const resource = "subsite-types";
+  const { orgId, orgType } = getSession();
+
+  if (!orgId && !orgType) {
+    throw new Error("Organization id and type are required");
+  }
+
+  const get = {
+    /**
+     * @returns {obj} envelope
+     */
+    async all() {
+      const url = `${_getUrl()}?${_getUrlParams(arguments)}`;
+
+      return await Api.get(url);
+    },
+
+    /**
+     * Gets a speficific subsite of an organization
+     *
+     * @param {number/string} id
+     * @param {number/string} page
+     * @returns {object} envelope
+     */
+    async specific(id) {
+      const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+      return await Api.get(url);
+    },
+
+    async stats(id) {
+      const url = `${_getUrl()}/${id}/stats`;
+
+      return await Api.get(url);
+    }
+  };
+
+  const post = (data) => {
+    const url = `${_getUrl()}?${_getUrlParams()}`;
+
+    return Api.post(url, data);
+  }
+
+  const update = (id, data) => {
+    const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+    return Api.update(url, data);
+  }
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getUrlParams = (args) => {
+    const paramsString = createParamsStringFromArgs(args);
+
+    return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
+  };
+
+  return {
+    get,
+    post,
+    update
+  };
+};

package/src/services/subsites.js

@@ -37,14 +37,20 @@ export const createSubsitesApiService = () => {
       const url = `${_getUrl()}/${id}/stats`;
 
       return await Api.get(url);
-    }
+    },
   };
 
   const post = (data) => {
     const url = `${_getUrl()}?${_getUrlParams()}`;
 
     return Api.post(url, data);
-  }
+  };
+
+  const update = (id, data) => {
+    const url = `${_getUrl()}/${id}?${_getUrlParams()}`;
+
+    return Api.update(url, data);
+  };
 
   const _getUrl = () => {
     return `${Api.baseUrl}/${resource}`;
@@ -58,6 +64,7 @@ export const createSubsitesApiService = () => {
 
   return {
     get,
-    post
+    post,
+    update,
   };
 };

package/src/services/subsites2.js

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

package/src/utils/methods.js

@@ -0,0 +1,16 @@
+import Api from "../helpers/api";
+import { createParamsStringFromArgs } from "../utils/args";
+
+export const all = async (url) => {
+  return await Api.get(url);
+};
+
+export const getUrl = (resource) => {
+  return `${Api.baseUrl}/${resource}`;
+};
+
+export const getUrlParams = (args) => {
+  const paramsString = createParamsStringFromArgs(args);
+
+  return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
+};

package/package-lock.json

@@ -1,13 +0,0 @@
-{
-  "name": "@veritree/services",
-  "version": "0.3.0",
-  "lockfileVersion": 2,
-  "requires": true,
-  "packages": {
-    "": {
-      "name": "@veritree/services",
-      "version": "0.3.0",
-      "license": "MIT"
-    }
-  }
-}