@veritree/services 2.34.0-0 → 2.35.0

package/index.js

@@ -21,6 +21,7 @@ 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 { TreeOrderStatuses } from './src/endpoints/tree-order-statuses';
 import { User } from './src/endpoints/user';
 import { Users } from './src/endpoints/users';
 import { Utilities } from './src/endpoints/utilities';
@@ -37,7 +38,6 @@ import { Organizations } from './src/endpoints/organizations';
 import { Tasks } from './src/endpoints/tasks';
 import { Geometries } from './src/endpoints/geometries';
 import { Password } from './src/endpoints/password';
-import { TreeCodes } from './src/endpoints/tree-codes';
 
 export {
   BulkUploads,
@@ -63,6 +63,7 @@ export {
   SubsiteTypes,
   Tags,
   TreeOrders,
+  TreeOrderStatuses,
   User,
   Users,
   Utilities,
@@ -78,6 +79,5 @@ export {
   Organizations,
   Tasks,
   Geometries,
-  Password,
-  TreeCodes
+  Password
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veritree/services",
-  "version": "2.34.0-0",
+  "version": "2.35.0",
   "description": "A collection of javascript functions/services to talk to veritree API",
   "type": "module",
   "main": "index.js",
@@ -12,6 +12,5 @@
   },
   "dependencies": {
     "np": "^7.6.2"
-  },
-  "devDependencies": {}
+  }
 }

package/src/endpoints/field-reports.js

@@ -28,6 +28,11 @@ class FieldReportsApi extends Api {
       detach
     }
   }
+
+  blockchain(fieldReportId, params) {
+    const url = `${this.getUrl()}/${fieldReportId}${this.getUrlParams(params)}`;
+    return this.get(url)
+  }
 }
 
 export const FieldReports = new FieldReportsApi();

package/src/endpoints/organizations.js

@@ -1,9 +1,9 @@
-import Api from "../helpers/api";
+import Api from '../helpers/api';
 
 class OrganizationsApi extends Api {
   constructor(resource) {
     super(resource);
-    this.resource = "organizations";
+    this.resource = 'organizations';
   }
 
   tasks(orgId) {
@@ -14,12 +14,6 @@ class OrganizationsApi extends Api {
       return await this.get(url);
     };
 
-    /**
-     * Creates a new task with the specified data.
-     *
-     * @param {Object} taskData - An object containing the data for the new task.
-     * @returns {Promise<Object>} - A Promise that resolves to the created task object.
-     */
     const create = async (data) => {
       url = `${url}${this.getUrlParams()}`;
       return await this.post(url, data);

package/src/endpoints/orgs.js

@@ -24,12 +24,12 @@ class OrgsApi extends Api {
   }
 
   async stats() {
-    const url = `${this._getStatstUrl()}`;
+    const url = `${this._geStatstUrl()}`;
     return await this.get(url);
   }
 
-  async publicStats(args) {
-    const url = `${this._getStatstUrl(true, args)}`;
+  async publicStats() {
+    const url = `${this._geStatstUrl(true)}`;
     return await this.get(url);
   }
 
@@ -56,9 +56,9 @@ class OrgsApi extends Api {
     };
   }
 
-  _getStatstUrl(isPublic, args) {
+  _geStatstUrl(isPublic) {
     const endpoint = isPublic ? 'pstats' : 'stats';
-    return `${this.getUrl()}/${endpoint}${this.getUrlParams(args)}`;
+    return `${this.getUrl()}/${endpoint}${this.getUrlParams()}`;
   }
 }
 

package/src/endpoints/password.js

@@ -1,10 +1,10 @@
 import Api from "../helpers/api";
 
 /**
- * This is a namespace that contains documentation elements belonging to the Password domain.
- * 
- * @class
- * @module Password
+ * This is a namespace that contains documentation elements 
+ * belonging to the Password domain.
+ *
+ * @namespace Password
  */
 class PasswordApi extends Api {
   constructor(resource) {
@@ -12,18 +12,13 @@ class PasswordApi extends Api {
     this.resource = "password";
   }
 
-  /**
-   * @function
-   * @name recovery
-   * @returns {Object}
-   */
   recovery() {
     /**
      * Sends a recovery password email to the specified email address.
      *
      * @param {Object} data - An object containing the following properties:
-     *   @param {string} data.email - The email address to send the recovery email to.
-     *   @param {string} [data.return_url] - The URL to redirect the user to after they reset their password.
+     * @param {string} data.email - The email address to send the recovery email to.
+     * @param {string} [data.return_url] - The URL to redirect the user to after they reset their password.
      * @returns {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the email was sent successfully.
      */
     const post = async (data) => {
@@ -37,11 +32,6 @@ class PasswordApi extends Api {
     };
   }
 
-  /**
-   * @function
-   * @name reset
-   * @returns {Object}
-   */
   reset() {
     /**
      * Sends a POST request to reset a password with the specified email, token, and password.
@@ -54,7 +44,7 @@ class PasswordApi extends Api {
      * @returns {Promise<Object>} - A Promise that resolves to the result of the POST request.
      */
     const post = async (data) => {
-      const url = `${this.getUrl()}/reset`;
+      const url = `${this.getUrl()}/reset`
 
       return await this.post(url, data);
     };
@@ -65,4 +55,4 @@ class PasswordApi extends Api {
   }
 }
 
-export const Password = new PasswordApi();
+export const Password = new PasswordApi();

package/src/endpoints/planting-sites.js

@@ -1,20 +1,9 @@
-import Api from "../helpers/api";
+import Api from '../helpers/api';
 
 class PlantingSitesApi extends Api {
   constructor(resource) {
     super(resource);
-    this.resource = "planting-sites";
-  }
-
-  public() {
-    const single = async (plantingSiteId) => {
-      const url = `${this.getUrl()}/public/${plantingSiteId}`;
-      return await this.get(url);
-    };
-
-    return {
-      single,
-    };
+    this.resource = 'planting-sites';
   }
 
   users(plantingSiteId) {
@@ -43,7 +32,7 @@ class PlantingSitesApi extends Api {
       url = `${this.getUrl()}/${subsiteId}/media/images/${imageId}${this.getUrlParams(
         params
       )}`;
-      return await this.post(url, null, "delete");
+      return await this.post(url, null, 'delete');
     };
 
     return {
@@ -65,7 +54,7 @@ class PlantingSitesApi extends Api {
       url = `${this.getUrl()}/${subsiteId}/media/attachments/${attachmentId}${this.getUrlParams(
         params
       )}`;
-      return await this.post(url, null, "delete");
+      return await this.post(url, null, 'delete');
     };
 
     return {
@@ -86,6 +75,47 @@ class PlantingSitesApi extends Api {
       all,
     };
   }
+
+  evidence(subsiteId, params) {
+    let url = `${this.getUrl()}/${subsiteId}/evidence`;
+
+    console.log(url);
+
+    const all = async () => {
+      url = `${url}${this.getUrlParams(params)}`;
+      return await this.get(url);
+    };
+
+    const attach = async (formData) => {
+      url = `${url}${this.getUrlParams(params)}`;
+      return await this.post(url, formData);
+    };
+
+    const remove = async (evidenceType, evidenceId) => {
+      url = `${url}/${evidenceType}/${evidenceId}${this.getUrlParams(
+        params
+      )}`;
+
+      return await this.post(url, null, "delete");
+    };
+
+    return {
+      all,
+      attach,
+      delete: remove,
+    };
+  }
+
+  stats(subsiteId) {
+    const all = async (args) => {
+      const url = `${this.getUrl()}/${subsiteId}/stats${this.getUrlParams(args)}`;
+      return await this.get(url);
+    };
+
+    return {
+      all,
+    };
+  }
 }
 
 export const PlantingSites = new PlantingSitesApi();

package/src/endpoints/regions.js

@@ -27,6 +27,15 @@ class RegionsApi extends Api {
       all,
     };
   }
+  listRegions(orgId,orgType) {
+  const all = async () => {
+    const url = `${this.getUrl()}/public?org_id=${orgId}&org_type=${orgType}&_v=10.0.0`;
+    return await this.get(url);
+  };
+  return {
+    all,
+  };
+}
 }
 
 export const Regions = new RegionsApi();

package/src/endpoints/sponsors.js

@@ -6,38 +6,28 @@ class SponsorsApi extends Api {
     this.resource = 'sponsors';
   }
 
-  async map(orgId) {
+  async map() {
+    this.setOrg();
 
-    if (!orgId) {
+    if (!this.orgId) {
       throw new Error('No org id provided');
     }
 
-    const url = `${this.getUrl()}/${orgId}/map-data`;
+    const url = `${this.getUrl()}/${this.orgId}/map-data`;
     return await this.get(url);
   }
 
-  async profile(args) {
-    const params = this.getUrlParams(args);
+  async profile() {
+    this.setOrg();
 
     if (!this.orgId) {
       throw new Error('No org id provided');
     }
 
-    const url = `${this.getUrl()}/${this.orgId}/profile${params}`;
+    const url = `${this.getUrl()}/${this.orgId}/profile`;
     return await this.get(url);
   }
 
-  plantingSites(orgId) {
-    const all = async () => {
-      const url = `${this.getUrl()}/${orgId}/planting-sites`;
-      return await this.get(url);
-    };
-
-    return {
-      all
-    };
-  }
-
   async plantingStats(args) {
     const url = `${this.getUrl()}/planting-stats${this.getUrlParams(args)}`;
     return await this.get(url);
@@ -59,9 +49,7 @@ class SponsorsApi extends Api {
     };
 
     const imageUploadUrl = async () => {
-      const url = `${this.getUrl()}/${
-        this.orgId
-      }/cms/image-upload-url${urlParams}`;
+      const url = `${this.getUrl()}/${this.orgId}/cms/image-upload-url${urlParams}`;
       return await this.get(url);
     };
 
@@ -79,21 +67,19 @@ class SponsorsApi extends Api {
 
   tools(args) {
     const get = async (sponsorId) => {
-      const url = `${this.getUrl()}/${sponsorId}/tools${this.getUrlParams(
-        args
-      )}`;
+      const url = `${this.getUrl()}/${sponsorId}/tools${this.getUrlParams(args)}`;
       return await this.get(url);
-    };
+    }
 
     const create = async (sponsorId, data) => {
       const url = `${this.getUrl()}/${sponsorId}/tools`;
       return await this.post(url, data);
-    };
+    }
 
     return {
       get,
-      create,
-    };
+      create
+    }
   }
 }
 

package/src/endpoints/standards.js

@@ -13,19 +13,126 @@ class StandardsApi extends Api {
       return await this.get(url);
     };
 
+    const create = async (data, args) => {
+      const url = `${this.getUrl()}/themes?${createParamsStringFromArgs(args)}`;
+      return await this.post(url, data);
+    };
+
+    const update = async (themeId, data, args) => {
+      const url = `${this.getUrl()}/themes/${themeId}?${createParamsStringFromArgs(
+        args
+      )}`;
+      return await this.post(url, data, 'patch');
+    };
+
+    const remove = async (args) => {
+      const url = `${this.getUrl()}/themes/${themeId}?${createParamsStringFromArgs(
+        args
+      )}`;
+      return await this.post(url, data, 'delete');
+    };
+
+    const goals = (themeId) => {
+      const create = async (data, args) => {
+        const url = `${this.getUrl()}/themes/${themeId}/goals?${createParamsStringFromArgs(
+          args
+        )}`;
+        return await this.post(url, data);
+      };
+
+      const indicators = (goalId) => {
+        const create = async (data, args) => {
+          const url = `${this.getUrl()}/themes/${themeId}/goals/${goalId}/indicators?${createParamsStringFromArgs(
+            args
+          )}`;
+          return await this.post(url, data);
+        };
+
+        return {
+          create,
+        };
+      };
+
+      return {
+        create,
+        indicators,
+      };
+    };
+
+    const UNSDGs = (themeId) => {
+      const create = async (data) => {
+        console.log('this.getUrl:', this.getUrl())
+        const url = `${this.getUrl()}/themes/${themeId}/attach-sdg`;
+        return await this.post(url, data);
+      };
+      return {
+        create
+      };
+    };
+
     return {
       all,
+      create,
+      update,
+      delete: remove,
+      goals,
+      UNSDGs
     };
   }
 
-  goals() {
-    const single = async (goalId) => {
+  goals(goalId) {
+    const single = async () => {
       const url = `${this.getUrl()}/goals/${goalId}`;
       return await this.get(url);
     };
 
+    const update = async (data) => {
+      const url = `${this.getUrl()}/goals/${goalId}`;
+      return await this.post(url, data, 'patch');
+    };
+
+    const remove = async () => {
+      const url = `${this.getUrl()}/goals/${goalId}`;
+      return await this.post(url, null, 'delete');
+    };
+
+    return {
+      single,
+      update,
+      delete: remove,
+    };
+  }
+
+  indicators(indicatorId) {
+    const single = async () => {
+      const url = `${this.getUrl()}/indicators/${indicatorId}`;
+      return await this.get(url);
+    };
+
+    const update = async (data) => {
+      const url = `${this.getUrl()}/indicators/${indicatorId}`;
+      return await this.post(url, data, 'patch');
+    };
+
+    const remove = async () => {
+      const url = `${this.getUrl()}/indicators/${indicatorId}`;
+      return await this.post(url, null, 'delete');
+    };
+
     return {
       single,
+      update,
+      delete: remove,
+    };
+  }
+  UNSDGs(themeId){
+    const attach = async (data) => {
+      const url = `${this.getUrl()}/themes/${themeId}/attach-sdg`;
+      return await this.update(url,{"sdg_id":data})
+    };
+
+    return {
+      attach
     };
   }
 }

package/src/endpoints/stats.js

@@ -5,12 +5,13 @@ class StatsApi extends Api {
     super(resource);
   }
 
-  async crumb(id, args) {
+  async crumb(id) {
     this.resource = 'pstats';
-    const url = `${this.getUrl()}/${id}${this.getUrlParams(args)}`;
+    const url = `${this.getUrl()}/${id}${this.getUrlParams()}`;
 
     return await this.get(url);
   }
 }
 
 export const Stats = new StatsApi();
+

package/src/endpoints/tree-order-statuses.js

@@ -0,0 +1,5 @@
+import Api from "../helpers/api";
+
+const resource = "tree-order-statuses";
+
+export const TreeOrderStatuses = new Api(resource);

package/src/helpers/api.js

@@ -1,33 +1,80 @@
-import { getCookie } from './cookies';
-import { getSession } from './session';
-import { createParamsStringFromArgs } from '../utils/args';
-
+import { getCookie } from "./cookies";
+import { createParamsStringFromArgs } from "../utils/args";
+import { getSession } from "./session";
+
+/**
+ * Returns the runtime configuration object for Nuxt 3.
+ *
+ * Note:
+ * This function should only be used with Nuxt 3.
+ * For Nuxt 2, the environment variables will work as expected.
+ *
+ * @returns {Object|null} - The runtime configuration object, or null if it's not available.
+ */
+// function getNuxtRuntimeConfig() {
+//   if (typeof useRuntimeConfig === "function") {
+//     return useRuntimeConfig();
+//   } else {
+//     return null;
+//   }
+// }
+
+// function getVersion() {
+//   if (process) {
+//     process?.env?.API_VERITREE_VERSION;
+//   } else {
+//     const nuxtRuntimeConfig = getNuxtRuntimeConfig();
+
+//     if (nuxtRuntimeConfig) {
+//       return nuxtRuntimeConfig.public.API_VERITREE_VERSION;
+//     }
+//   }
+
+//   return "5.0.0";
+// }
+
+/**
+ * Adds a version parameter to a URL if it does not already have one.
+ * If an environment variable called API_VERITREE_VERSION is defined, its value is used as the version,
+ * otherwise the default version "5.0.0" is used.
+ *
+ * @param {string} url - The URL to modify.
+ * @returns {string} The modified URL with the version parameter appended to it.
+ */
 function addVersionParam(url) {
   // If URL is invalid or already has the result parameter, return it as is
-  if (!url || url.includes('_result=1')) {
+  if (!url || url.includes("_result=1")) {
     return url;
   }
 
   // Check if URL already has the version parameter
-  if (url.includes('_v=')) {
+  if (url.includes("_v=")) {
     return url;
   }
 
-  const version = '10.0.0';
+  // Use environment variable if available, otherwise use default version
+  const version = process.env.API_VERITREE_VERSION || "5.0.0";
 
   // Append version parameter to URL
-  const urlVersionParam = url.includes('?')
+  const urlVersionParam = url.includes("?")
     ? `&_v=${version}`
     : `?_v=${version}`;
 
   return `${url}${urlVersionParam}`;
 }
 
+/**
+ * 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 isGet = method === "get";
   const isSpoofing = as;
   const isFormData = data instanceof FormData;
-  const accessToken = `Bearer ${getCookie('access_token')}`;
+  const accessToken = `Bearer ${getCookie("access_token")}`;
 
   const config = {
     method,
@@ -37,7 +84,7 @@ function getConfig(method, data, as) {
   };
 
   if (!isFormData) {
-    config.headers['Content-Type'] = 'application/json';
+    config.headers["Content-Type"] = "application/json";
   }
 
   // TODO: improve this ifs and elses
@@ -45,7 +92,7 @@ function getConfig(method, data, as) {
     if (!data) data = {};
 
     if (isFormData) {
-      if (isSpoofing) data.set('_method', as.toUpperCase());
+      if (isSpoofing) data.set("_method", as.toUpperCase());
       config.body = data;
     } else {
       if (isSpoofing) data._method = as.toUpperCase();
@@ -58,8 +105,17 @@ function getConfig(method, data, as) {
 
 export default class Api {
   constructor(resource) {
-    this.baseUrl = null;
-    this.resource = resource ? resource : '';
+    // Nuxt 3
+    // const nuxtConfig = getNuxtRuntimeConfig();
+    // const url =
+    //   nuxtConfig?.public?.API_VERITREE_URL ||
+    //   process?.env?.API_VERITREE_URL ||
+    //   null;
+
+    // this.baseUrl = url + "/api";
+
+    this.baseUrl = process.env ? `${process.env.API_VERITREE_URL}/api` : null;
+    this.resource = resource ? resource : "";
     this.orgId = null;
     this.orgType = null;
   }
@@ -68,58 +124,110 @@ export default class Api {
     this.baseUrl = baseUrl;
   }
 
+  /**
+   *
+   * @returns {promise}
+   */
   async all(args) {
     const url = `${this.getUrl()}${this.getUrlParams(args)}`;
     return await this.get(url);
   }
 
+  /**
+   *
+   * @param {string, number} id
+   * @param {object} args/params
+   * @returns {promise}
+   */
   async single(id, args) {
-    const params = this.args ? this.getUrlParams(args) : '';
-    const url = `${this.getUrl(id)}${params}`;
+    const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.get(url);
   }
 
+  /**
+   *
+   * @param {object} data
+   * @returns {promise}
+   */
   async create(data, args) {
     return await this.post(null, data, null, args);
   }
 
-  async update(id, data, as = 'put', args) {
+  /**
+   *
+   * @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", args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.post(url, data, as);
   }
 
+  /**
+   *
+   * @param {string} url
+   * @param {object} data
+   * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
+   * @returns {promise}
+   */
   async delete(id, args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
-    return await this.post(url, null, 'delete');
+    return await this.post(url, null, "delete");
   }
 
+  /**
+   *
+   * @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, args) {
     if (!url) url = `${this.getUrl()}${this.getUrlParams(args)}`;
-    return await this.unWrap(url, 'post', data, as);
+    return await this.unWrap(url, "post", data, as);
   }
 
+  // ----------
+  // --
+  /**
+   *
+   * @param {string, number} id
+   * @returns
+   */
   getUrl(id) {
-    id = id ? `/${id}` : '';
+    id = id ? `/${id}` : "";
     return `${this.baseUrl}/${this.resource}${id}`;
   }
 
+  /**
+   *
+   * @param {object} args
+   * @returns {string}
+   */
   getUrlParams(args) {
+    this.setOrg();
     let isOrgLess = false;
     let isOrgIdAs = false;
     let isOrgTypeAs = false;
-    let orgIdParam = '';
-    let orgTypeParam = '';
-    let argsClone = { ...args }; // avoids mutating object
+    let orgIdParam = "";
+    let orgTypeParam = "";
+    let argsClone = structuredClone(args); // avoids mutating object
 
     // while most of endpoints require an org id and type, some endpoints do not
     if (argsClone) {
-      isOrgLess = Object.hasOwn(argsClone, 'orgless');
-      isOrgIdAs = Object.hasOwn(argsClone, 'org_id_as');
-      isOrgTypeAs = Object.hasOwn(argsClone, 'org_type_as');
+      isOrgLess = Object.hasOwn(argsClone, "orgless");
+      isOrgIdAs = Object.hasOwn(argsClone, "org_id_as");
+      isOrgTypeAs = Object.hasOwn(argsClone, "org_type_as");
     }
 
     // a super admin user can create/edit data from other orgs
@@ -145,18 +253,20 @@ export default class Api {
       }
     }
 
-    if (!this.orgId && !this.orgType) {
-      const session = getSession();
-      this.orgId = session.orgId;
-      this.orgType = session.orgType;
-    }
-
     return `?${orgIdParam}${orgTypeParam}${createParamsStringFromArgs(
       argsClone
     )}`;
   }
 
-  async unWrap(url, method = 'get', data, as) {
+  /**
+   * Deals with all fetch requests
+   *
+   * @param {string} url
+   * @param {string} method
+   * @param {object} data
+   * @returns {object} envelope
+   */
+  async unWrap(url, method = "get", data, as) {
     url = addVersionParam(url);
     const config = getConfig(method, data, as);
     const response = await fetch(url, config);
@@ -172,4 +282,12 @@ export default class Api {
       });
     });
   }
+
+  setOrg() {
+    const session = getSession();
+    if (!session) return;
+    const { orgId, orgType } = session;
+    this.orgId = orgId;
+    this.orgType = orgType;
+  }
 }

package/jsdoc.json

@@ -1,16 +0,0 @@
-{
-  "source": {
-    "include": ["src/endpoints"],
-    "includePattern": ".js$",
-    "excludePattern": "(node_modules/|docs)"
-  },
-  "plugins": ["plugins/markdown"],
-  "templates": {
-    "cleverLinks": true,
-    "monospaceLinks": true
-  },
-  "opts": {
-    "recurse": true,
-    "destination": "./documentation/"
-  }
-}

package/src/endpoints/tree-codes.js

@@ -1,43 +0,0 @@
-import Api from "../helpers/api";
-
-class TreeCodesApi extends Api {
-  constructor(resource) {
-    super(resource);
-    this.resource = "tree-codes";
-  }
-
-  holders() {
-    const claim = async (treeCodeHolder) => {
-      const url = `${this.getUrl()}/holders/claim/${treeCodeHolder}`;
-      return await this.get(url);
-    };
-
-    return {
-      claim,
-    };
-  }
-
-  stats() {
-    const all = async () => {
-      const url = `${this.getUrl()}/stats`;
-      return await this.get(url);
-    }
-
-    return {
-      all
-    }
-  }
-
-  status() {
-    const single = async (treeCodeHolder) => {
-      const url = `${this.getUrl()}/status/${treeCodeHolder}`;
-      return await this.get(url);
-    }
-
-    return {
-      single
-    }
-  }
-}
-
-export const TreeCodes = new TreeCodesApi();