@veritree/services 0.3.0 → 0.6.1

package/index.js

@@ -1,13 +1,27 @@
-import { createSponsorsApiService } from './src/services/sponsors.js';
+import { createCountriesApiService } from './src/services/countries.js';
+import { createFieldUpdatesApiService } from './src/services/field-updates.js';
+import { createFormSubmissionsApiService } from './src/services/form-submissions.js';
+import { createForestTypesApiService } from './src/services/forest-types.js';
+import { createImagesApiService } from './src/services/images.js';
+import { createMeApiService } from './src/services/me.js';
 import { createOrgsApiService } from './src/services/orgs.js';
-import { createForestTypesApiService } from './src/services/forestTypes.js';
+import { createRegionsApiService } from './src/services/regions.js';
+import { createSponsorsApiService } from './src/services/sponsors.js';
 import { createSubdomainsApiService } from './src/services/subdomains.js';
-import { createCountriesApiService } from './src/services/countries.js';
+import { createSubsitesApiService } from './src/services/subsites.js';
+import { createTreeOrdersApiService } from './src/services/trees-orders.js';
 
 export {
-  createSponsorsApiService,
-  createOrgsApiService,
+  createCountriesApiService,
+  createFieldUpdatesApiService,
   createForestTypesApiService,
+  createFormSubmissionsApiService,
+  createOrgsApiService,
+  createImagesApiService,
+  createMeApiService,
+  createRegionsApiService,
+  createSponsorsApiService,
   createSubdomainsApiService,
-  createCountriesApiService
+  createSubsitesApiService,
+  createTreeOrdersApiService,
 }

package/package-lock.json

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

package/package.json

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

package/src/services/countries.js

@@ -1,23 +1,35 @@
 import Api from '../helpers/api';
 
-export const createCountriesApiService = (countryId) => {
-
+export const createCountriesApiService = () => {
   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() {
-      // Look for a country ID if none provided global stats will be sent
+    async get(countryId) {
       const type = countryId ? `${countryId}` : 'global';
-      const url = _getUrl(type +'/stats');
+      const url = `${_getUrl()}/${type}/stats`;
+
       return await Api.get(url);
     }
   }
 
-  const _getUrl = (endpoint) => {
-    return `${Api.baseUrl}/${resource}/${endpoint}`;
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
   };
 
   return {
+    get,
     stats
   };
 };

package/src/services/field-updates.js

@@ -0,0 +1,39 @@
+import Api from '../helpers/api';
+
+export const createFieldUpdatesApiService = (orgId, orgType) => {
+  const resource = `field-updates`;
+
+  const get = {
+    async all(countryId, regionId, subsiteId, page = 1, pageSize = 10) {
+      const params = `${_getParams(
+        countryId,
+        regionId,
+        subsiteId,
+        page,
+        pageSize
+      )}`;
+      const url = `${_getUrl()}?${params}`;
+
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getParams = (countryId, regionId, subsiteId, page, pageSize) => {
+    const countryIdParam = countryId ? `&country_id=${countryId}` : '';
+    const regionIdParam = regionId ? `&region_id=${regionId}` : '';
+    const subsiteIdParam = subsiteId ? `&subsite_id=${subsiteId}` : '';
+    const pageParam = page ? `&page=${page}` : '';
+    const pageSizeParam = pageSize ? `&page_size=${pageSize}` : '';
+    const params = `${countryIdParam}${regionIdParam}${subsiteIdParam}${pageParam}${pageSizeParam}`;
+
+    return `org_id=${orgId}&org_type=${orgType}${params}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/forest-types.js

@@ -0,0 +1,41 @@
+import Api from '../helpers/api';
+
+// TODO: Add all possible parameters as in API
+export const createForestTypesApiService = () => {
+  const get = {
+    /**
+     * Gets all forest types of an organization
+     *
+     * @param {boolean} isPublic
+     * @returns {object} envelope
+     */
+    async all(isPublic = false) {
+      const url = `${_getUrl(isPublic)}`;
+      return await Api.get(url);
+    },
+
+    /**
+     * Gets a speficific forest type of an organization
+     *
+     * @param {number/string} id
+     * @param {boolean} isPublic
+     * @returns {object} envelope
+     */
+    async specific(id, isPublic = false) {
+      const url = `${_getUrl(isPublic)}/${id}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getResource = (isPublic) => {
+    return isPublic ? 'forest-type-profiles' : `forest-types`;
+  };
+
+  const _getUrl = (isPublic) => {
+    return `${Api.baseUrl}/${_getResource(isPublic)}`
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/form-submissions.js

@@ -0,0 +1,34 @@
+import Api from '../helpers/api';
+
+export const createFormSubmissionsApiService = (orgId, orgType) => {
+  if (!orgId) throw new Error('orgId and orgType are required');
+  const resource = 'form-submissions';
+
+  const get = {
+    async all(page = 1, pageSize = 10) {
+      const url = `${_getUrl()}?${_getParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+
+    // async specific(formId) {
+    //   const url = `${_getUrl()}/${orgId}/forms/${formId}?${_getParams()}`;
+    //   return await Api.get(url);
+    // },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getParams = (page, pageSize) => {
+    const pageParam = page ? `&page=${page}` : '';
+    const pageSizeParam = pageSize ? `&page_size=${pageSize}` : '';
+    const params = `${pageParam}${pageSizeParam}`;
+
+    return `org_id=${orgId}&org_type=${orgType}${params}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/forms.js

@@ -0,0 +1,33 @@
+import Api from '../helpers/api';
+
+export const createFormApiService = (orgId, orgType) => {
+  if (!orgId && !orgType) throw new Error('orgId and orgType are required');
+  const resource = 'orgs';
+
+  const get = {
+    async all(page = 1, pageSize = 10) {
+      const url = `${_getUrl()}/${orgId}/forms?${_getParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+
+    async specific(formId) {
+      const url = `${_getUrl()}/${orgId}/forms/${formId}?${_getParams()}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getParams = (page, pageSize) => {
+    const paramPageSize = pageSize ? `&page_size=${pageSize}` : '';
+    const paramPage = page ? `&page=${page}` : '';
+
+    return `org_type=${orgType}${paramPageSize}${paramPage}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/images.js

@@ -0,0 +1,55 @@
+import Api from "../helpers/api";
+
+export const createImagesApiService = (orgId, orgType) => {
+  if (!orgId && !orgType) throw new Error("orgId and orgType are required");
+  const resource = "images";
+
+  const get = {
+    async all(
+      purpose,
+      countryId,
+      regionId,
+      subsiteId,
+      page = 1,
+      pageSize = 10
+    ) {
+      const url = `${_getUrl()}?${_getParams(
+        purpose,
+        countryId,
+        regionId,
+        subsiteId,
+        page,
+        pageSize
+      )}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getParams = (
+    purpose,
+    countryId,
+    regionId,
+    subsiteId,
+    page,
+    pageSize
+  ) => {
+    const paramPageSize = pageSize ? `&page_size=${pageSize}` : "";
+    const paramPurpose = purpose ? `&purpose=${purpose}` : "";
+    const paramCountryId = countryId ? `&country_id=${countryId}` : "";
+    const paramRegionId = regionId ? `&region_id=${regionId}` : "";
+    const paramSubsiteId = subsiteId ? `&subsite_id=${subsiteId}` : "";
+    const paramPage = page ? `&page=${page}` : "";
+
+    const params = `${paramPurpose}${paramPageSize}${paramCountryId}${paramRegionId}${paramSubsiteId}${paramPage}`;
+
+    return `org_id=${orgId}&org_type=${orgType}${params}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/me.js

@@ -0,0 +1,20 @@
+import Api from '../helpers/api';
+
+export const createMeApiService = () => {
+  const resource = 'me';
+
+  const get = {
+    async me() {
+      const url = _getUrl();
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/orgs.js

@@ -8,7 +8,7 @@ export const createOrgsApiService = (orgId, orgType) => {
   const stats = {
     async get(isPublic) {
       const endpoint = _getStatsEndpoint(isPublic);
-      const url = _getUrl(endpoint);
+      const url = `${_getUrl()}/${endpoint}?${_getUrlParams()}`;
       return await Api.get(url);
     },
   };
@@ -17,10 +17,14 @@ export const createOrgsApiService = (orgId, orgType) => {
     return isPublic ? 'pstats' : 'stats';
   }
 
-  const _getUrl = (endpoint) => {
-    return `${Api.baseUrl}/${resource}/${endpoint}?org_id=${orgId}&org_type=${orgType}`;
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
   };
 
+  const _getUrlParams = () => {
+    return `org_id=${orgId}&org_type=${orgType}`
+  }
+
   return {
     stats,
   };

package/src/services/regions.js

@@ -0,0 +1,28 @@
+import Api from '../helpers/api';
+
+export const createRegionsApiService = (orgId, orgType) => {
+  if (!orgId && !orgType) throw new Error('orgId and orgType are required');
+  const resource = 'regions';
+
+  const get = {
+    async all(page = 1, pageSize = 10) {
+      const url = `${_getUrl()}?${_getParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getParams = (page, pageSize) => {
+    const paramPage = page ? `&page=${page}` : '';
+    const paramPageSize = pageSize ? `&page_size=${pageSize}` : '';
+
+    return `org_id=${orgId}&org_type=${orgType}${paramPage}${paramPageSize}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/sponsors.js

@@ -7,7 +7,7 @@ export const createSponsorsApiService = (orgId) => {
   // filter for map data
   const map = {
     async get() {
-      const url = _getUrl('map-data');
+      const url = `${_getUrl()}/${orgId}/map-data`;
       return await Api.get(url);
     },
   };
@@ -15,13 +15,13 @@ export const createSponsorsApiService = (orgId) => {
   // filter for profile
   const profile = {
     async get() {
-      const url = _getUrl('profile');
+      const url = `${_getUrl()}/${orgId}/profile`;
       return await Api.get(url);
     },
   };
 
-  const _getUrl = (endpoint) => {
-    return `${Api.baseUrl}/${resource}/${orgId}/${endpoint}`;
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
   };
 
   return {

package/src/services/subdomains.js

@@ -5,17 +5,19 @@ export const createSubdomainsApiService = () => {
 
   const get = {
     /**
+     * Gets org data related to subdomain
+     * 
      * @param {string} id (name or id)
      * @returns {object} evenlop
      */
     async specific(id) {
-      const url = _getUrl(id);
+      const url = `${_getUrl()}/${id}`;
       return await Api.get(url);
     },
   };
 
-  function _getUrl(id) {
-    return `${Api.baseUrl}/${resource}/${id}`;
+  function _getUrl() {
+    return `${Api.baseUrl}/${resource}`;
   }
 
   return {

package/src/services/subsites.js

@@ -0,0 +1,43 @@
+import Api from '../helpers/api';
+
+export const createSubsitesApiService = (orgId, orgType) => {
+  if (!orgId && !orgType) throw new Error('orgId is required');
+  const resource = 'subsites';
+
+  const get = {
+    /**
+     * Gets all subsites of an organization
+     *
+     * @param {number/string} page
+     * @returns {object} envelope
+     */
+    async all(page = 1, pageSize = 10) {
+      const url = `${_getUrl()}?${_getUrlParams(page, pageSize)}`;
+      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, page = 1, pageSize = 10) {
+      const url = `${_getUrl()}/${id}?${_getUrlParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getUrlParams = (page, pageSize) => {
+    return `org_id=${orgId}&org_type=${orgType}&page=${page}&page_size=${pageSize}`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/trees-orders.js

@@ -0,0 +1,42 @@
+import Api from '../helpers/api';
+
+export const createTreeOrdersApiService = (orgId, orgType) => {
+  const resource = 'tree-orders';
+
+  const get = {
+    /**
+     * 
+     * @param {number/string} page
+     * @param {number/string} pageSize
+     * @returns {object} envelope
+     */
+    async all(page = 1, pageSize = 10) {
+      const url = `${_getUrl()}?${_getUrlParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+
+    /**
+     * 
+     * @param {number/string} id
+     * @param {number/string} page
+     * @param {number/string} pageSize
+     * @returns {object} envelope
+     */
+    async specific(id, page = 1, pageSize = 10) {
+      const url = `${_getUrl()}/${id}?${_getUrlParams(page, pageSize)}`;
+      return await Api.get(url);
+    },
+  };
+
+  const _getUrl = () => {
+    return `${Api.baseUrl}/${resource}`;
+  };
+
+  const _getUrlParams = (page, pageSize) => {
+    return `org_id=${orgId}&org_type=${orgType}&page=${page}&page_size=${pageSize}&include=tree_allocations`;
+  };
+
+  return {
+    get,
+  };
+};

package/src/services/forestTypes.js

@@ -1,41 +0,0 @@
-import Api from '../helpers/api';
-
-// TODO: Add all possible parameters as in API
-export const createForestTypesApiService = () => {
-  /**
-   * Gets the right resource for the request based on the isPublic flag.
-   *
-   * @param {boolean} isPublic
-   * @returns {string} resource
-   */
-  const _getResource = (isPublic) => {
-    return isPublic ? 'forest-type-profiles' : `forest-types`;
-  };
-
-  const get = {
-    async all(isPublic = false) {
-      const url = _handleUrl(isPublic);
-      return await Api.get(url);
-    },
-
-    async specific(id, isPublic = false) {
-      const url = _handleUrl(isPublic, id);
-      return await Api.get(url);
-    },
-  };
-
-  function _handleUrl(isPublic, id) {
-    const resource = _getResource(isPublic);
-    return _getUrl(resource, id);
-  }
-
-  function _getUrl(resource, id) {
-    return id
-      ? `${Api.baseUrl}/${resource}/${id}`
-      : `${Api.baseUrl}/${resource}`;
-  }
-
-  return {
-    get,
-  };
-};