Rewrite store JSDoc, split quote/order into modules, and generate typed API docs

- Rewrite JSDoc across all store methods to document the actual async
  methods (real params, returns, throws) instead of the internal wrappers
- Split quote/order into individual module files backed by shared
  manifestDoc helpers; remove the createStore factory and thin wrappers
- Deduplicate manifest line helpers into src/store/manifestLines.js
- Extend generate-api-doc.js to render parameter/return/throws types and
  emit per-namespace API.<module>.md files with an API.md index
- Regenerate all API docs
This commit is contained in:
seb
2026-08-07 06:23:17 +02:00
parent 396389457f
commit aefd97a171
127 changed files with 3956 additions and 1684 deletions

View File

@@ -1,20 +1,22 @@
import { GET_BY_ID, SET_OFF, LIST_CATEGORY_IDS } from '../../sql/posterminal.js';
import resolveSelectedCompanyAccess from '../companyuser/resolveSelectedCompanyAccess.js';
/**
* Removes a category assignment from a posterminal (turns it off).
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that removes a category from a posterminal.
*
* @example
* const fn = setOff(pool);
* const result = await fn(42, 5, 9);
* // => { id, categoryIds: [...] }
*/
export default function setOff(pool) {
const access = resolveSelectedCompanyAccess(pool);
/**
* Removes a category assignment from a posterminal (turns it off).
*
* @param {number} googleAuthId - The id of the Google auth user.
* @param {number} posterminalId - The id of the posterminal.
* @param {number} categoryId - The id of the category to remove.
* @returns {Promise<{id: number, categoryIds: Array<number>}>} The posterminal with its remaining category ids.
* @throws {Error} If the posterminal is not found.
*
* @example
* const result = await store.posterminal.setOff(42, 5, 9);
* // => { id, categoryIds: [...] }
*/
return async (googleAuthId, posterminalId, categoryId) => {
if (!Number.isFinite(posterminalId) || !Number.isFinite(categoryId)) {
throw new Error('Invalid posterminal or category');