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,16 +1,14 @@
import { SCHEMA_SCRIPTS } from '../schema.js';
/**
* Initializes the database schema by running all schema scripts.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that initializes the schema.
*
* @example
* const fn = initialize(pool);
* await fn();
*/
export default function initialize(pool) {
/**
* Initializes the database schema by running all schema scripts.
*
* @returns {Promise<void>}
*
* @example
* await store.initialize();
*/
return async () => {
for (const script of SCHEMA_SCRIPTS) {
await pool.request().query(script);