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

@@ -2,6 +2,18 @@ import { ENSURE_TYPE } from '../../sql/numbers.js';
import request from '../request.js';
export default function peekNumber(pool) {
/**
* Returns the next number for a company and type without consuming it.
*
* @param {number} companyId - The id of the company.
* @param {string} type - The number type (e.g. `'entity'`, `'sku'`).
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<string>} The next number.
*
* @example
* const number = await store.numbers.peek(1, 'entity');
* // => '1'
*/
return async (companyId, type, tx) => {
await request(pool, tx)
.input('companyId', companyId)