docs: add JSDoc headers to all externally exported store functions

src/store/companysetting/delete.js

@@ -1,6 +1,16 @@
 import { DELETE_BY_COMPANY_AND_KEY } from '../../sql/companysetting.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 
+/**
+ * Deletes a company setting by key.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that deletes a company setting.
+ *
+ * @example
+ * const fn = del(pool);
+ * await fn(42, 1, 'theme');
+ */
 export default function del(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/companysetting/get.js

@@ -2,6 +2,17 @@ import { GET_BY_COMPANY_AND_KEY } from '../../sql/companysetting.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 import shapeSetting from './shapeSetting.js';
 
+/**
+ * Returns a single company setting by key.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that fetches a company setting.
+ *
+ * @example
+ * const fn = get(pool);
+ * const setting = await fn(42, 1, 'theme');
+ * // => { key, value, frontend }
+ */
 export default function get(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/companysetting/list.js

@@ -5,6 +5,17 @@ import {
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 import shapeSetting from './shapeSetting.js';
 
+/**
+ * Lists the settings of a company, optionally only frontend-visible ones.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that lists company settings.
+ *
+ * @example
+ * const fn = list(pool);
+ * const settings = await fn(42, 1, { frontendOnly: true });
+ * // => [{ key, value, frontend }]
+ */
 export default function list(pool) {
   const access = resolveCompanyAccess(pool);
 

src/store/companysetting/set.js

@@ -2,6 +2,17 @@ import { GET_BY_COMPANY_AND_KEY, UPSERT } from '../../sql/companysetting.js';
 import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
 import shapeSetting from './shapeSetting.js';
 
+/**
+ * Sets (upserts) a company setting by key.
+ *
+ * @param {object} pool - The mssql connection pool.
+ * @returns {Function} An async function that sets a company setting.
+ *
+ * @example
+ * const fn = set(pool);
+ * const setting = await fn(42, 1, { key: 'theme', value: 'dark', frontend: true });
+ * // => { key, value, frontend }
+ */
 export default function set(pool) {
   const access = resolveCompanyAccess(pool);