@veritree/services 1.0.0-1 → 1.0.0-4

package/index.js

@@ -1,45 +1,37 @@
-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';
+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';
 
 export {
-  createCountriesApiService,
   Countries,
-  createFieldUpdatesApiService,
-  createFieldUpdateVerificationsApiService,
-  createForestTypeSpeciesApiService,
+  FieldUpdates,
+  FieldUpdateVerifications,
   ForestTypeSpecies,
-  createForestTypesApiService,
   ForestTypes,
-  createFormSubmissionsApiService,
-  createOrgsApiService,
-  createImagesApiService,
+  ForestTypeProfiles,
+  FormSubmissions,
+  Orgs,
   Images,
-  createMeApiService,
-  createRegionsApiService,
+  User,
   Regions,
-  createSponsorsApiService,
-  createSubdomainsApiService,
-  createSubsitesApiService,
+  Sponsors,
+  Stats,
+  Subdomains,
   Subsites,
-  createSubsiteTypesApiService,
-  createTreeOrdersApiService,
+  SubsiteTypes,
+  TreeOrders
 }

package/package.json

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

package/src/helpers/api.js

@@ -1,38 +1,91 @@
 import { getCookie } from "./cookies";
+import { createParamsStringFromArgs } from "../utils/args";
+import { getSession } from "./session";
 
-const Api = {
-  baseUrl: `${process.env.API_VERITREE_URL}/api`,
-  forceEnvelopeResponse: true, // TODO: remove when API is fully migrated to envelopes
+export default class Api {
+  constructor(resource) {
+    this.baseUrl = `${process.env.API_VERITREE_URL}/api`;
+    this.resource = resource;
+    this.orgId = null;
+    this.orgType = null;
+  }
 
   /**
-   * 
-   * @param {string} url 
+   *
    * @returns {promise}
    */
-  async get(url) {
-    return await this.unWrap(url);
-  },
+  async all() {
+    const url = `${this.getUrl()}${this.getUrlParams(arguments)}`;
+    return await this.get(url);
+  }
 
   /**
-   * 
-   * @param {string} url 
-   * @param {object} data 
+   *
+   * @param {string, number} id
    * @returns {promise}
    */
-  async post(url, data, as) {
-    return await this.unWrap(url, "post", data, as);
-  },
+  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 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(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}
+   */
+  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
@@ -42,8 +95,8 @@ const Api = {
    * @param {object} data
    * @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
+  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 {
@@ -54,7 +107,7 @@ const Api = {
     } catch (err) {
       throw new Error(err);
     }
-  },
+  };
 
   /**
    * Handles how the data should be sent in the fetch method
@@ -63,11 +116,11 @@ const Api = {
    * @param {object} body
    * @returns {object} data
    */
-  getConfig(method, data, as) {
+  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 isFormData = this.isFormData(data);
+    const accessToken = `Bearer ${getCookie("access_token")}`;
 
     const config = {
       method,
@@ -76,23 +129,31 @@ 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;
-  },
+  };
+
+  setOrg = () => {
+    const session = getSession();
+    if(!session) return;
+    const { orgId, orgType } = session;
+    this.orgId = orgId;
+    this.orgType = orgType;
+  }
 
   /**
    * Adds the envelope argument to the url
@@ -100,18 +161,14 @@ const Api = {
    * @param {string} url
    * @returns {string} url
    */
-  handleEnvelopParam(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) {
-    return data instanceof FormData;
-  },
-};
+  };
 
-export default Api;
+  isFormData = (data) => data instanceof FormData;
+}

package/src/services/countries.js

@@ -1,35 +1,5 @@
-import Api from '../helpers/api';
+import Api from "../helpers/api";
 
-export const createCountriesApiService = () => {
-  const resource = 'countries';
+const resource = "countries";
 
-  const get = {
-    async all() {
-      const url = _getUrl();
-      return await Api.get(url);
-    },
-
-    async specific(countriId) {
-      const url = `${_getUrl()}/${countriId}`;
-      return await Api.get(url);
-    }
-  }
-
-  const stats = {
-    async get(countryId) {
-      const type = countryId ? `${countryId}` : 'global';
-      const url = `${_getUrl()}/${type}/stats`;
-
-      return await Api.get(url);
-    }
-  }
-
-  const _getUrl = () => {
-    return `${Api.baseUrl}/${resource}`;
-  };
-
-  return {
-    get,
-    stats
-  };
-};
+export const Countries = new Api(resource);

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

@@ -1,34 +1,5 @@
 import Api from "../helpers/api";
-import { getSession } from "../helpers/session";
 
-export const createFieldUpdateVerificationsApiService = () => {
-  const resource = `field-update-verifications`;
-  const { orgId, orgType } = getSession();
+const resource = "field-update-verifications";
 
-  if (!orgId && !orgType) {
-    throw new Error('Organization id and type are required');
-  }
-
-  /**
-   *
-   * @param {object} data
-   * @returns
-   */
-   const post = (data) => {
-    const url = `${_getUrl()}?${_getParams()}`;
-
-    return Api.post(url, data);
-  };
-
-  const _getUrl = () => {
-    return `${Api.baseUrl}/${resource}`;
-  };
-
-  const _getParams = () => {
-    return `org_id=${orgId}&org_type=${orgType}`;
-  };
-
-  return {
-    post,
-  };
-};
+export const FieldUpdateVerifications = new Api(resource);

package/src/services/field-updates.js

@@ -1,77 +1,5 @@
 import Api from "../helpers/api";
-import { getSession } from "../helpers/session";
-import { createParamsStringFromArgs } from "../utils/args";
 
-export const createFieldUpdatesApiService = () => {
-  const resource = `field-updates`;
-  const { orgId, orgType } = getSession();
+const resource = "field-updates";
 
-  if (!orgId && !orgType) {
-    throw new Error('Organization id and type are required');
-  }
-
-  const get = {
-    async all() {
-      const url = `${_getUrl()}?${_getParams(arguments)}`;
-
-      return await Api.get(url);
-    },
-
-    async specific(id) {
-      const url = `${_getUrl()}/${id}?${_getParams()}`;
-
-      return await Api.get(url);
-    }
-  };
-
-  /**
-   *
-   * @param {object} data
-   * @returns
-   */
-   const post = (data) => {
-    const url = `${_getUrl()}?${_getParams()}`;
-
-    return Api.post(url, data);
-  };
-
-  /**
-   *
-   * @param {string} fieldUpdateId
-   * @param {object} data
-   * @returns
-   */
-  const update = (fieldUpdateId, data) => {
-    const url = `${_getUrl()}/${fieldUpdateId}?${_getParams()}`;
-
-    return Api.post(url, data);
-  };
-
-  /**
-   * 
-   */
-  const remove = {
-    async img(fieldUpdateId, data) {
-      const url = `${_getUrl()}/${fieldUpdateId}/images/detach?${_getParams()}`;
-
-      return await Api.post(url, data);
-    }
-  }
-
-  const _getUrl = () => {
-    return `${Api.baseUrl}/${resource}`;
-  };
-
-  const _getParams = (args) => {
-    const paramsString = createParamsStringFromArgs(args);
-
-    return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
-  };
-
-  return {
-    get,
-    post,
-    update,
-    remove
-  };
-};
+export const FieldUpdates = new Api(resource);

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

@@ -1,63 +1,5 @@
 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();
+const resource = "forest-type-species";
 
-  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,
-  };
-};
+export const ForestTypeSpecies = new Api(resource);

package/src/services/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/services/forest-types.js

@@ -1,62 +1,5 @@
 import Api from "../helpers/api";
-import { createParamsStringFromArgs } from "../utils/args";
-import { getSession } from "../helpers/session";
 
-export const createForestTypesApiService = () => {
-  const resource = "forest-types";
-  const { orgId, orgType } = getSession();
+const resource = "forest-types";
 
-  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,
-  };
-};
+export const ForestTypes = new Api(resource);

package/src/services/form-submissions.js

@@ -1,33 +1,5 @@
-import Api from '../helpers/api';
-import { getSession } from "../helpers/session";
-import { createParamsStringFromArgs } from '../utils/args';
+import Api from "../helpers/api";
 
-export const createFormSubmissionsApiService = () => {
-  const resource = 'form-submissions';
-  const { orgId, orgType } = getSession();
+const resource = "form-submissions";
 
-  if (!orgId && !orgType) {
-    throw new Error('Organization id and type are required');
-  }
-
-  const get = {
-    async all() {
-      const url = `${_getUrl()}?${_getParams(arguments)}`;
-      return await Api.get(url);
-    },
-  };
-
-  const _getUrl = () => {
-    return `${Api.baseUrl}/${resource}`;
-  };
-
-  const _getParams = (args) => {
-    const paramsString = createParamsStringFromArgs(args);
-
-    return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
-  };
-
-  return {
-    get,
-  };
-};
+export const FormSubmissions = new Api(resource);

package/src/services/images.js

@@ -1,39 +1,5 @@
 import Api from "../helpers/api";
-import { getSession } from "../helpers/session";
-import { createParamsStringFromArgs } from "../utils/args";
 
-export const createImagesApiService = () => {
-  const resource = "images";
-  const { orgId, orgType } = getSession();
+const resource = "images";
 
-  if (!orgId && !orgType) {
-    throw new Error("Organization id and type are required");
-  }
-
-  const get = {
-    async all() {
-      const url = `${_getUrl()}?${_getParams(arguments)}`;
-      return await Api.get(url);
-    },
-
-    async specific(id) {
-      const url = `${_getUrl()}/${id}?${_getParams()}`;
-
-      return await Api.get(url);
-    },
-  };
-
-  const _getUrl = () => {
-    return `${Api.baseUrl}/${resource}`;
-  };
-
-  const _getParams = (args) => {
-    const paramsString = createParamsStringFromArgs(args);
-
-    return `org_id=${orgId}&org_type=${orgType}${paramsString}`;
-  };
-
-  return {
-    get,
-  };
-};
+export const Images = new Api(resource);