docs: add JSDoc headers to all externally exported store functions

src/store/entitycontact/create.js

@@ -12,6 +12,17 @@ function shape(row) {
   };
 }
 
+/**
+ * Creates a new contact for an entity.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that creates an entity contact.
+ *
+ * @example
+ * const fn = create(pool);
+ * const contact = await fn(42, 1, 5, { contactType: 'email', contact: 'a@b.c' });
+ * // => { id, entityId, contactType, contact, sort }
+ */
 export default function create(pool) {
   const access = resolveCompanyAccess(pool);
   const entityAccess = resolveEntityAccess(pool);

src/store/entitycontact/delete.js

@@ -2,6 +2,16 @@ import { DELETE_BY_ENTITY_AND_ID } from '../../sql/entitycontact.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 import resolveEntityAccess from '../entity/resolveEntityAccess.js';
 
+/**
+ * Deletes a contact of an entity.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that deletes an entity contact.
+ *
+ * @example
+ * const fn = del(pool);
+ * await fn(42, 1, 5, 9);
+ */
 export default function del(pool) {
   const access = resolveCompanyAccess(pool);
   const entityAccess = resolveEntityAccess(pool);

src/store/entitycontact/list.js

@@ -12,6 +12,17 @@ function shape(row) {
   };
 }
 
+/**
+ * Lists the contacts of an entity.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that lists entity contacts.
+ *
+ * @example
+ * const fn = list(pool);
+ * const contacts = await fn(42, 1, 5);
+ * // => [{ id, entityId, contactType, contact, sort }]
+ */
 export default function list(pool) {
   const access = resolveCompanyAccess(pool);
   const entityAccess = resolveEntityAccess(pool);

src/store/entitycontact/update.js

@@ -12,6 +12,17 @@ function shape(row) {
   };
 }
 
+/**
+ * Updates a contact of an entity.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that updates an entity contact.
+ *
+ * @example
+ * const fn = update(pool);
+ * const contact = await fn(42, 1, 5, 9, { contact: 'b@c.d' });
+ * // => { id, entityId, contactType, contact, sort }
+ */
 export default function update(pool) {
   const access = resolveCompanyAccess(pool);
   const entityAccess = resolveEntityAccess(pool);