@veritree/services 2.29.2 → 2.30.0

package/index.js

@@ -36,6 +36,7 @@ import { PlantingSites } from './src/endpoints/planting-sites';
 import { Organizations } from './src/endpoints/organizations';
 import { Tasks } from './src/endpoints/tasks';
 import { Geometries } from './src/endpoints/geometries';
+import { Password } from './src/endpoints/password';
 
 export {
   BulkUploads,
@@ -75,5 +76,6 @@ export {
   PlantingSites,
   Organizations,
   Tasks,
-  Geometries
+  Geometries,
+  Password
 };

package/jsdoc.json

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

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@veritree/services",
-  "version": "2.29.2",
+  "version": "2.30.0",
   "description": "A collection of javascript functions/services to talk to veritree API",
   "type": "module",
+  "scripts": {
+    "doc": "jsdoc -c jsdoc.json"
+  },
   "main": "index.js",
   "repository": "https://github.com/tentree-org/veritree-services.git",
   "author": "cyroveritree <cyro@veritree.com>",
@@ -12,5 +15,8 @@
   },
   "dependencies": {
     "np": "^7.6.2"
+  },
+  "devDependencies": {
+    "jsdoc": "^4.0.2"
   }
 }

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,6 +14,12 @@ 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

@@ -0,0 +1,58 @@
+import Api from "../helpers/api";
+
+/**
+ * This is a namespace that contains documentation elements 
+ * belonging to the Password domain.
+ *
+ * @namespace Password
+ */
+class PasswordApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "password";
+  }
+
+  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.
+     * @returns {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the email was sent successfully.
+     */
+    const post = async (data) => {
+      const url = `${this.getUrl()}/email`;
+
+      return await this.post(url, data);
+    };
+
+    return {
+      post,
+    };
+  }
+
+  reset() {
+    /**
+     * Sends a POST request to reset a password with the specified email, token, and password.
+     *
+     * @param {Object} data - An object containing the following properties:
+     *   @param {string} data.email - The email address of the user whose password is being reset.
+     *   @param {string} data.token - The token associated with the password reset request.
+     *   @param {string} data.password - The new password to set for the user.
+     *   @param {string} data.password_confirmation - The new password confimation to set for the user.
+     * @returns {Promise<Object>} - A Promise that resolves to the result of the POST request.
+     */
+    const post = async (data) => {
+      const url = `${this.getUrl()}/reset`
+
+      return await this.post(url, data);
+    };
+
+    return {
+      post,
+    };
+  }
+}
+
+export const Password = new PasswordApi();

package/src/helpers/api.js

@@ -1,6 +1,6 @@
 import { getCookie } from "./cookies";
-import { createParamsStringFromArgs } from "../utils/args";
 import { getSession } from "./session";
+import { createParamsStringFromArgs } from "../utils/args";
 
 /**
  * Returns the runtime configuration object for Nuxt 3.
@@ -11,27 +11,27 @@ import { getSession } from "./session";
  *
  * @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";
-// }
+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.
@@ -53,7 +53,7 @@ function addVersionParam(url) {
   }
 
   // Use environment variable if available, otherwise use default version
-  const version = process.env.API_VERITREE_VERSION || "5.0.0";
+  const version = getVersion();
 
   // Append version parameter to URL
   const urlVersionParam = url.includes("?")
@@ -106,15 +106,13 @@ function getConfig(method, data, as) {
 export default class Api {
   constructor(resource) {
     // Nuxt 3
-    // const nuxtConfig = getNuxtRuntimeConfig();
-    // const url =
-    //   nuxtConfig?.public?.API_VERITREE_URL ||
-    //   process?.env?.API_VERITREE_URL ||
-    //   null;
-
-    // this.baseUrl = url + "/api";
+    const nuxtConfig = getNuxtRuntimeConfig();
+    const url =
+      nuxtConfig?.public?.API_VERITREE_URL ||
+      process?.env?.API_VERITREE_URL ||
+      null;
 
-    this.baseUrl = process.env ? `${process.env.API_VERITREE_URL}/api` : null;
+    this.baseUrl = url ? `${url}/api` : null;
     this.resource = resource ? resource : "";
     this.orgId = null;
     this.orgType = null;