docs: add JSDoc headers to all externally exported store functions

src/store/supplier/create.js

@@ -4,6 +4,17 @@ import request from '../request.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 import ensureLieferantenGroup from './ensureLieferantenGroup.js';
 
+/**
+ * Creates a new supplier for a company, recording history.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that creates a supplier.
+ *
+ * @example
+ * const fn = create(pool);
+ * const supplier = await fn(42, 1, { name: 'Acme Supplies' });
+ * // => { id, name, createdAt, updatedAt }
+ */
 export default function create(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/supplier/delete.js

@@ -1,6 +1,16 @@
 import { DELETE_BY_ID, SUPPLIER_GROUP_NAME } from '../../sql/entity.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 
+/**
+ * Deletes a supplier by its id within a company.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that deletes a supplier.
+ *
+ * @example
+ * const fn = del(pool);
+ * await fn(42, 1, 5);
+ */
 export default function del(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/supplier/list.js

@@ -1,6 +1,17 @@
 import { LIST_SUPPLIERS_BY_COMPANY, SUPPLIER_GROUP_NAME } from '../../sql/entity.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 
+/**
+ * Lists the suppliers of a company.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that lists suppliers.
+ *
+ * @example
+ * const fn = list(pool);
+ * const suppliers = await fn(42, 1);
+ * // => [{ id, name, createdAt, updatedAt }]
+ */
 export default function list(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/supplier/update.js

@@ -17,6 +17,17 @@ function shape(row) {
   };
 }
 
+/**
+ * Updates the name of a supplier, recording history.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that updates a supplier.
+ *
+ * @example
+ * const fn = update(pool);
+ * const supplier = await fn(42, 1, 5, { name: 'Acme GmbH' });
+ * // => { id, name, createdAt, updatedAt }
+ */
 export default function update(pool) {
   const access = resolveCompanyAccess(pool);