@veritree/services 2.65.0 → 2.66.0

package/package.json

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

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,
   };
 };