@veritree/services 2.30.1 → 2.31.0

package/index.js

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

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,6 +1,6 @@
 {
   "name": "@veritree/services",
-  "version": "2.30.1",
+  "version": "2.31.0",
   "description": "A collection of javascript functions/services to talk to veritree API",
   "type": "module",
   "main": "index.js",
@@ -12,5 +12,6 @@
   },
   "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,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

@@ -1,10 +1,10 @@
 import Api from "../helpers/api";
 
 /**
- * This is a namespace that contains documentation elements 
- * belonging to the Password domain.
- *
- * @namespace Password
+ * This is a namespace that contains documentation elements belonging to the Password domain.
+ * 
+ * @class
+ * @module Password
  */
 class PasswordApi extends Api {
   constructor(resource) {
@@ -12,6 +12,11 @@ class PasswordApi extends Api {
     this.resource = "password";
   }
 
+  /**
+   * @function
+   * @name recovery
+   * @returns {Object}
+   */
   recovery() {
     /**
      * Sends a recovery password email to the specified email address.
@@ -32,6 +37,11 @@ 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.
@@ -44,7 +54,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);
     };
@@ -55,4 +65,4 @@ class PasswordApi extends Api {
   }
 }
 
-export const Password = new PasswordApi();
+export const Password = new PasswordApi();

package/src/endpoints/tree-codes.js

@@ -0,0 +1,21 @@
+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();

package/src/helpers/api.js

@@ -1,46 +1,7 @@
 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.
- *
- * 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")) {
@@ -52,8 +13,7 @@ function addVersionParam(url) {
     return url;
   }
 
-  // Use environment variable if available, otherwise use default version
-  const version = process.env.API_VERITREE_VERSION || "5.0.0";
+  const version = '10.0.0';
 
   // Append version parameter to URL
   const urlVersionParam = url.includes("?")
@@ -63,13 +23,7 @@ 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;
@@ -105,16 +59,7 @@ 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";
-
-    this.baseUrl = process.env ? `${process.env.API_VERITREE_URL}/api` : null;
+    this.baseUrl = null;
     this.resource = resource ? resource : "";
     this.orgId = null;
     this.orgType = null;
@@ -124,96 +69,45 @@ 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;
@@ -258,14 +152,6 @@ 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);