@veritree/services 2.64.0 → 2.66.0

package/package.json

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

package/src/endpoints/tasks.js

@@ -31,18 +31,94 @@ class TasksApi extends Api {
     const attach = async (data) => {
       url = `${url}/users-attach${this.getUrlParams()}`;
       return await this.post(url, data);
-    }
+    };
 
     const detach = async (data) => {
       url = `${url}/users-detach${this.getUrlParams()}`;
       return await this.post(url, data);
-    }
+    };
 
     return {
       attach,
-      detach
-    }
+      detach,
+    };
+  }
+
+  /**
+   * Returns a set of functions for interacting with task categories.
+   * @returns {Object} Object containing functions for CRUD operations on task categories.
+   */
+  categories() {
+    /**
+     * Generates a URL for task categories based on the provided organization ID and category ID.
+     * @param {string} orgId - The ID of the organization.
+     * @param {string|null} [categoryId] - The ID of the category (optional).
+     * @param {Object|null} [params] - Additional query parameters (optional).
+     * @returns {string} The generated URL.
+     */
+    const generateUrl = (orgId, categoryId, params) => {
+      const queryParams = this.getUrlParams(params);
+
+      if (categoryId) {
+        return `${this.baseUrl}/task-categories/${categoryId}${queryParams}`;
+      } else {
+        return `${this.baseUrl}/organizations/${orgId}/task-categories${queryParams}`;
+      }
+    };
+
+    /**
+     * Retrieves all task categories for a given organization.
+     * @param {string} orgId - The ID of the organization.
+     * @param {Object|null} [params] - Additional query parameters (optional).
+     * @returns {Promise} A promise that resolves with the list of task categories.
+     */
+    const all = async (orgId, params) => {
+      const url = generateUrl(orgId, null, params);
+      return await this.get(url);
+    };
+
+    /**
+     * Creates a new task category for a given organization.
+     * @param {string} orgId - The ID of the organization.
+     * @param {Object} data - The data for creating the task category.
+     * @param {Object|null} [params] - Additional query parameters (optional).
+     * @returns {Promise} A promise that resolves with the created task category.
+     */
+    const create = async (orgId, data, params) => {
+      const url = generateUrl(orgId, null, params);
+      return await this.post(url, data);
+    };
+
+    /**
+     * Updates a task category.
+     * @param {string|null} categoryId - The ID of the category to be updated.
+     * @param {Object} data - The data to update the task category with.
+     * @param {Object|null} [params] - Additional query parameters (optional).
+     * @returns {Promise} A promise that resolves with the updated task category.
+     */
+    const update = async (categoryId, data, params) => {
+      const url = generateUrl(null, categoryId, params);
+      return await this.post(url, data, "patch");
+    };
+
+    /**
+     * Deletes a task category.
+     * @param {string|null} categoryId - The ID of the category to be deleted.
+     * @param {Object|null} [params] - Additional query parameters (optional).
+     * @returns {Promise} A promise that resolves when the category is deleted.
+     */
+    const remove = async (categoryId, params) => {
+      const url = generateUrl(null, categoryId, params);
+      return await this.post(url, null, 'delete');
+    };
+
+    return {
+      all,
+      create,
+      update,
+      delete: remove,
+    };
   }
 }
 
-export const Tasks = new TasksApi();
+export const Tasks = new TasksApi();

package/src/helpers/relations.js

@@ -1,31 +1,81 @@
+/**
+ * Creates a Relations object to handle API relations.
+ * @param {object} api - The API object used for making API calls.
+ * @param {string} relationPrefix - The prefix for relation endpoints.
+ * @param {string} relationId - The identifier for the relation.
+ * @returns {object} The Relations object.
+ */
 const Relations = (api, relationPrefix, relationId) => {
   let url = `${api.baseUrl}/${relationPrefix}/${relationId}/${api.resource}`;
 
-  const all = async (args) => {
-    url = `${url}${api.getUrlParams(args)}`;
+  /**
+   * Retrieves all tags.
+   * @param {object} params - Additional parameters for the request.
+   * @returns {Promise<object>} A promise that resolves with the response data.
+   */
+  const all = async (params) => {
+    url = `${url}${api.getUrlParams(params)}`;
     return await api.get(url);
   };
 
-  const single = async (id, args) => {
-    url = `${url}/${id}${api.getUrlParams(args)}`;
+  /**
+   * Retrieves a single tag by ID.
+   * @param {string} tagId - The ID of the tag to retrieve.
+   * @param {object} params - Additional parameters for the request.
+   * @returns {Promise<object>} A promise that resolves with the response data.
+   */
+  const single = async (tagId, params) => {
+    url = `${url}/${tagId}${api.getUrlParams(params)}`;
     return await api.get(url);
   };
 
-  const attach = async (id, data, args) => {
-    url = `${url}/${id}/attach${api.getUrlParams(args)}`;
+  /**
+   * Attaches a tag to a resource.
+   * @param {string} tagId - The ID of the tag to attach.
+   * @param {object} data - The data to send with the request.
+   * @param {object} params - Additional parameters for the request.
+   * @returns {Promise<object>} A promise that resolves with the response data.
+   */
+  const attach = async (tagId, data, params) => {
+    url = `${url}/${tagId}/attach${api.getUrlParams(params)}`;
     return await api.post(url, data);
   };
 
-  const detach = async (id, args) => {
-    url = `${url}/${id}/detach${api.getUrlParams(args)}`;
+  /**
+   * Detaches a tag from a resource.
+   * @param {string} tagId - The ID of the tag to detach.
+   * @param {object} params - Additional parameters for the request.
+   * @returns {Promise<object>} A promise that resolves with the response data.
+   */
+  const detach = async (tagId, params) => {
+    url = `${url}/${tagId}/detach${api.getUrlParams(params)}`;
     return await api.post(url, null, "delete");
   };
 
+  /**
+   * Retrieves usable tags.
+   * @param {object} params - Additional parameters for the request.
+   * @returns {Promise<object>} A promise that resolves with the response data.
+   */
+  const usable = async (params) => {
+    url = `${
+      api.baseUrl
+    }/${relationPrefix}/${relationId}/usable-tags${api.getUrlParams(params)}`;
+    return await api.get(url);
+  };
+
+  const attached = async (params) => {
+    url = `${url}/${api.getUrlParams(params)}`;
+    return await api.get(url);
+  };
+
   return {
     all,
+    attached,
     single,
     attach,
     detach,
+    usable,
   };
 };