u

src/api/routes/ledger.js

@@ -1,5 +1,7 @@
 import * as db from '../../db/ledger.js';
 
+// #region Helpers
+
 function requireSelectedCompany(req) {
     const companyId = req.user.selectedCompanyId;
     if (companyId == null) {
@@ -20,6 +22,8 @@ function ledgerErrorStatus(error) {
     return 500;
 }
 
+// #endregion
+
 /**
  * Registers ledger routes for the authenticated user's selected company.
  * @param {import('express').Application} app
@@ -86,6 +90,8 @@ export function register(app, basePath = '') {
      *             schema:
      *               $ref: '#/components/schemas/Error'
      */
+    // #region POST /ledger
+
     app.post(`${basePath}/ledger`, async (req, res) => {
         const selected = requireSelectedCompany(req);
         if (selected.error) {
@@ -102,6 +108,8 @@ export function register(app, basePath = '') {
         }
     });
 
+    // #endregion
+
     /**
      * @openapi
      * /ledger/manifestarticle/{manifestarticleId}:
@@ -160,6 +168,8 @@ export function register(app, basePath = '') {
      *             schema:
      *               $ref: '#/components/schemas/Error'
      */
+    // #region GET /ledger/manifestarticle/:manifestarticleId
+
     app.get(`${basePath}/ledger/manifestarticle/:manifestarticleId`, async (req, res) => {
         const selected = requireSelectedCompany(req);
         if (selected.error) {
@@ -183,6 +193,8 @@ export function register(app, basePath = '') {
         }
     });
 
+    // #endregion
+
     /**
      * @openapi
      * /ledger/sku/{sku}:
@@ -241,6 +253,8 @@ export function register(app, basePath = '') {
      *             schema:
      *               $ref: '#/components/schemas/Error'
      */
+    // #region GET /ledger/sku/:sku
+
     app.get(`${basePath}/ledger/sku/:sku`, async (req, res) => {
         const selected = requireSelectedCompany(req);
         if (selected.error) {
@@ -260,6 +274,8 @@ export function register(app, basePath = '') {
         }
     });
 
+    // #endregion
+
     /**
      * @openapi
      * /ledger:
@@ -306,6 +322,8 @@ export function register(app, basePath = '') {
      *             schema:
      *               $ref: '#/components/schemas/Error'
      */
+    // #region GET /ledger
+
     app.get(`${basePath}/ledger`, async (req, res) => {
         const selected = requireSelectedCompany(req);
         if (selected.error) {
@@ -340,4 +358,6 @@ export function register(app, basePath = '') {
             res.status(status).json({ error: error.message });
         }
     });
+
+    // #endregion
 }