@veritree/services 2.22.0 → 2.23.0

package/package.json

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

package/src/helpers/api.js

@@ -1,25 +1,35 @@
-import { getCookie } from './cookies';
-import { createParamsStringFromArgs } from '../utils/args';
-import { getSession } from './session';
+import { getCookie } from "./cookies";
+import { createParamsStringFromArgs } from "../utils/args";
+import { getSession } from "./session";
 
 /**
- * Adds the envelope argument to the url
+ * 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
- * @returns {string} url
+ * @param {string} url - The URL to modify.
+ * @returns {string} The modified URL with the version parameter appended to it.
  */
-function addVersionArg(url) {
-  if (!url || url.includes('_result=1')) return url;
-
-  const version = process.env
-    ? process.env.API_VERITREE_VERSION
-      ? process.env.API_VERITREE_VERSION
-      : '5.0.0'
-    : '5.0.0' || '5.0.0';
-  const urlHasArgs = url.includes('?');
-  const urlVersionArg = urlHasArgs ? `&_v=${version}` : `?_v=${version}`;
-
-  return `${url}${urlVersionArg}`;
+function addVersionParam(url) {
+  // If URL is invalid or already has the result parameter, return it as is
+  if (!url || url.includes("_result=1")) {
+    return url;
+  }
+
+  // Check if URL already has the version parameter
+  if (url.includes("_v=")) {
+    return url;
+  }
+
+  // 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("?")
+    ? `&_v=${version}`
+    : `?_v=${version}`;
+
+  return `${url}${urlVersionParam}`;
 }
 
 /**
@@ -30,10 +40,10 @@ function addVersionArg(url) {
  * @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,
@@ -43,7 +53,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
@@ -51,7 +61,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();
@@ -65,7 +75,7 @@ function getConfig(method, data, as) {
 export default class Api {
   constructor(resource) {
     this.baseUrl = process.env ? `${process.env.API_VERITREE_URL}/api` : null;
-    this.resource = resource ? resource : '';
+    this.resource = resource ? resource : "";
     this.orgId = null;
     this.orgType = null;
   }
@@ -110,7 +120,7 @@ export default class Api {
    * @param {string} as - 'put' // necessary for updates because of how Laravel handles PUT requests
    * @returns {promise}
    */
-  async update(id, data, as = 'put', args) {
+  async update(id, data, as = "put", args) {
     const url = `${this.getUrl(id)}${this.getUrlParams(args)}`;
     return await this.post(url, data, as);
   }
@@ -124,7 +134,7 @@ export default class Api {
    */
   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");
   }
 
   /**
@@ -144,7 +154,7 @@ export default class Api {
    */
   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);
   }
 
   // ----------
@@ -155,7 +165,7 @@ export default class Api {
    * @returns
    */
   getUrl(id) {
-    id = id ? `/${id}` : '';
+    id = id ? `/${id}` : "";
     return `${this.baseUrl}/${this.resource}${id}`;
   }
 
@@ -168,14 +178,14 @@ export default class Api {
     this.setOrg();
     let isOrgLess = false;
     let isOrgAs = false;
-    let orgIdParam = '';
-    let orgTypeParam = '';
+    let orgIdParam = "";
+    let orgTypeParam = "";
 
     // while most of endpoints require an org id and type, some endpoints do not
     if (args) {
-      isOrgLess = Object.hasOwn(args, 'orgless');
+      isOrgLess = Object.hasOwn(args, "orgless");
       isOrgAs =
-        Object.hasOwn(args, 'org_id_as') && Object.hasOwn(args, 'org_type_as');
+        Object.hasOwn(args, "org_id_as") && Object.hasOwn(args, "org_type_as");
     }
 
     // a super admin user can create/edit data from other orgs
@@ -206,8 +216,8 @@ export default class Api {
    * @param {object} data
    * @returns {object} envelope
    */
-  async unWrap(url, method = 'get', data, as) {
-    url = addVersionArg(url);
+  async unWrap(url, method = "get", data, as) {
+    url = addVersionParam(url);
     const config = getConfig(method, data, as);
     const response = await fetch(url, config);