@veritree/services 1.0.0-0 → 1.0.0-11

package/index.js

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

package/package.json

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

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

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

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

@@ -0,0 +1,5 @@
+import Api from "../helpers/api";
+
+const resource = "field-update-verifications";
+
+export const FieldUpdateVerifications = new Api(resource);

package/src/endpoints/field-updates.js

@@ -0,0 +1,5 @@
+import Api from "../helpers/api";
+
+const resource = "field-updates";
+
+export const FieldUpdates = new Api(resource);

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/images2.js → endpoints/images.js}

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

package/src/endpoints/notes.js

@@ -0,0 +1,13 @@
+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) => new Relations(this, prefix, id, args);
+}
+
+export const Notes = new NotesApi();

package/src/endpoints/orgs.js

@@ -0,0 +1,25 @@
+import Api from "../helpers/api";
+
+class OrgsApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "orgs";
+  }
+
+  async stats() {
+    const url = `${this._geStatstUrl()}`;
+    return await this.get(url);
+  }
+
+  async publicStats() {
+    const url = `${this._geStatstUrl(true)}`;
+    return await this.get(url);
+  }
+
+  _geStatstUrl(isPublic) {
+    const endpoint = isPublic ? "pstats" : "stats";
+    return `${this.getUrl()}/${endpoint}${this.getUrlParams()}`;
+  }
+}
+
+export const Orgs = new OrgsApi();

package/src/{services/regions2.js → endpoints/regions.js}

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

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/endpoints/sponsors.js

@@ -0,0 +1,34 @@
+import Api from '../helpers/api';
+
+class SponsorsApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = 'sponsors';
+  }
+
+  async map() {
+    this.setOrg();
+
+    if(!this.orgId) throw new Error('No org id provided');
+
+    const url = `${this.getUrl()}/${this.orgId}/map-data`;
+    return await this.get(url);
+  }
+
+  async profile() {
+    this.setOrg();
+
+    if(!this.orgId) throw new Error('No org id provided');
+
+    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);
+  }
+
+}
+
+export const Sponsors = new SponsorsApi();

package/src/endpoints/stats.js

@@ -0,0 +1,17 @@
+import Api from '../helpers/api';
+
+class StatsApi extends Api {
+  constructor(resource) {
+    super(resource);
+  }
+
+  async crumb(id) {
+    this.resource = 'pstats';
+    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
+
+    return await this.get(url);
+  }
+}
+
+export const Stats = new StatsApi();
+

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/endpoints/subsite-types.js

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

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

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

package/src/endpoints/tags.js

@@ -0,0 +1,13 @@
+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) => new Relations(this, prefix, id, args);
+}
+
+export const Tags = new TagsApi();

package/src/endpoints/trees-orders.js

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

package/src/endpoints/user.js

@@ -0,0 +1,15 @@
+import Api from '../helpers/api';
+
+class UserApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = 'me';
+  }
+
+  async me() {
+    const url = `${this.getUrl()}${this.getUrlParams()}`;
+    return await this.get(url);
+  }
+}
+
+export const User = new UserApi();

package/src/helpers/api.js

@@ -1,117 +1,209 @@
 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 addEnvelopeParam(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 isSpoofing = as !== undefined;
+  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 (!data) data = {};
+
+    if (isFormData) {
+      if (isSpoofing) data.set("_method", as.toUpperCase());
+      config.body = data;
+    } else {
+      if (isSpoofing) data._method = as.toUpperCase();
+      config.body = JSON.stringify(data);
+    }
+  }
+
+  return config;
+}
 
-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 ? resource : "";
+    this.orgId = null;
+    this.orgType = null;
+  }
 
   /**
-   * 
-   * @param {string} url 
+   *
    * @returns {promise}
    */
-  async get(url) {
-    return await this.unWrap(url);
-  },
+  async all(args) {
+    const url = `${this.getUrl()}${this.getUrlParams(args)}`;
+    return await this.get(url);
+  }
 
   /**
-   * 
-   * @param {string} url 
-   * @param {object} data 
+   *
+   * @param {string, number} id
+   * @param {object} args/params
    * @returns {promise}
    */
-  async post(url, data, as) {
-    return await this.unWrap(url, "post", data, as);
-  },
+  async single(id, args) {
+    const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
+    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} 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);
-  },
+  }
 
   /**
-   * Deals with all fetch requests
    *
    * @param {string} url
-   * @param {string} method
    * @param {object} data
-   * @returns {object} envelope
+   * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
+   * @returns {promise}
    */
-  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, as);
+  async delete(id) {
+    const url = `${this.getUrl(id)}${this.getUrlParams()}`;
+    return await this.post(url, null, "delete");
+  }
+
+  /**
+   *
+   * @param {string} url
+   * @returns {promise}
+   */
+  async get(url) {
+    return await this.unWrap(url);
+  }
 
-    try {
-      const response = await fetch(url, config);
-      const envelope = await response.json();
+  /**
+   *
+   * @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);
+  }
 
-      return envelope;
-    } catch (err) {
-      throw new Error(err);
-    }
-  },
+  // ----------
+  // --
+  /**
+   *
+   * @param {string, number} id
+   * @returns
+   */
+  getUrl(id) {
+    id = id ? `/${id}` : "";
+    return `${this.baseUrl}/${this.resource}${id}`;
+  }
 
   /**
-   * Handles how the data should be sent in the fetch method
    *
-   * @param {string} method
-   * @param {object} body
-   * @returns {object} data
+   * @param {object} args
+   * @returns {string}
    */
-  getConfig(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';
+  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");
     }
 
-    // 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);
-      }
+    if (!isOrgLess) {
+      if (this.orgId) orgIdParam = `org_id=${this.orgId}`;
+      if (this.orgType) orgTypeParam = `&org_type=${this.orgType}`;
     }
 
-    return config;
-  },
+    return `?${orgIdParam}${orgTypeParam}${createParamsStringFromArgs(args)}`;
+  }
 
   /**
-   * Adds the envelope argument to the url
+   * Deals with all fetch requests
    *
    * @param {string} url
-   * @returns {string} url
+   * @param {string} method
+   * @param {object} data
+   * @returns {object} envelope
    */
-  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;
-  },
-};
+  async unWrap(url, method = "get", data, as) {
+    url = addEnvelopeParam(url);
+    const config = getConfig(method, data, as);
+    const response = await fetch(url, config);
+
+    return new Promise((resolve, reject) => {
+      if (response.ok && response.status === 204) {
+        resolve();
+        return;
+      }
 
-export default Api;
+      response.json().then((json) => {
+        response.ok ? resolve(json) : reject(json);
+      });
+    });
+  }
+
+  setOrg() {
+    const session = getSession();
+    if (!session) return;
+    const { orgId, orgType } = session;
+    this.orgId = orgId;
+    this.orgType = orgType;
+  }
+}

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.unWrap(url);
+  }
+
+  const single = async(tagId) => {
+    url = `${url}/${tagId}${api.getUrlParams(args)}`;
+    return await api.unWrap(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/session.js

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