@veritree/services 2.31.1-0 → 2.32.0

package/index.js

@@ -37,7 +37,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,
@@ -78,6 +77,5 @@ export {
   Organizations,
   Tasks,
   Geometries,
-  Password,
-  TreeCodes
+  Password
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veritree/services",
-  "version": "2.31.1-0",
+  "version": "2.32.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/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/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

@@ -75,6 +75,36 @@ 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,
+    };
+  }
 }
 
 export const PlantingSites = new PlantingSitesApi();

package/src/endpoints/standards.js

@@ -13,19 +13,104 @@ 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,
+      };
+    };
+
     return {
       all,
+      create,
+      update,
+      delete: remove,
+      goals,
     };
   }
 
-  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,
     };
   }
 }

package/src/helpers/api.js

@@ -1,7 +1,46 @@
 import { getCookie } from "./cookies";
-import { getSession } from "./session";
 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")) {
@@ -13,7 +52,8 @@ function addVersionParam(url) {
     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("?")
@@ -23,7 +63,13 @@ function addVersionParam(url) {
   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 isSpoofing = as;
@@ -59,7 +105,16 @@ function getConfig(method, data, as) {
 
 export default class Api {
   constructor(resource) {
-    this.baseUrl = null;
+    // 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;
@@ -69,45 +124,96 @@ 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 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);
   }
 
+  /**
+   *
+   * @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");
   }
 
+  /**
+   *
+   * @param {string} url
+   * @returns {promise}
+   */
   async get(url) {
-    console.log(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);
   }
 
+  // ----------
+  // --
+  /**
+   *
+   * @param {string, number} id
+   * @returns
+   */
   getUrl(id) {
     id = id ? `/${id}` : "";
     return `${this.baseUrl}/${this.resource}${id}`;
   }
 
+  /**
+   *
+   * @param {object} args
+   * @returns {string}
+   */
   getUrlParams(args) {
     this.setOrg();
     let isOrgLess = false;
@@ -152,6 +258,14 @@ export default class Api {
     )}`;
   }
 
+  /**
+   * 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);

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,21 +0,0 @@
-import Api from "../helpers/api";
-
-class TreeCodesApi extends Api {
-  constructor(resource) {
-    super(resource);
-    this.resource = "tree-codes";
-  }
-
-  holders(args) {
-    const claim = async (treeCodeHolder) => {
-      const url = `${this.getUrl()}/holders/claim/${treeCodeHolder}${this.getUrlParams(args)}`;
-      return await this.get(url);
-    };
-
-    return {
-      claim,
-    };
-  }
-}
-
-export const TreeCodes = new TreeCodesApi();