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

@@ -0,0 +1,33 @@
import { QUOTE_TYPE } from '../../sql/manifestDoc.js';
import resolveSelectedCompanyAccess from '../companyuser/resolveSelectedCompanyAccess.js';
import { loadDoc } from '../manifestDoc/helpers.js';
export default function getById(pool) {
const access = resolveSelectedCompanyAccess(pool);
/**
* Returns a single quote by its id within the user's selected company.
*
* @param {number} googleAuthId - The id of the Google auth user.
* @param {number} id - The id of the quote.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The quote with its lines.
* @throws {Error} If the quote is not found.
*
* @example
* const quote = await store.quote.getById(42, 5);
* // => { id, number, type, entityId, date, lines: [...] }
*/
return async (googleAuthId, id) => {
if (!Number.isFinite(id)) {
throw new Error('Quote not found');
}
const { companyId } = await access(googleAuthId);
const doc = await loadDoc(pool, null, { type: QUOTE_TYPE, companyId, id });
if (!doc) {
throw new Error('Quote not found');
}
return doc;
};
}