u
This commit is contained in:
seb
342
src/api/routes/ledger.js
Normal file
342
src/api/routes/ledger.js
Normal file
@@ -0,0 +1,342 @@
|
||||
import * as db from '../../db/ledger.js';
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
return { companyId };
|
||||
}
|
||||
|
||||
function ledgerErrorStatus(error) {
|
||||
if (error.message === 'No company selected') return 400;
|
||||
if (error.message === 'Not authorized') return 403;
|
||||
if (error.message === 'Company not found') return 404;
|
||||
if (error.message === 'Manifest article not found') return 404;
|
||||
if (error.message === 'Invalid ledger entry') return 400;
|
||||
if (error.message === 'Invalid manifest article id') return 400;
|
||||
if (error.message === 'Invalid SKU') return 400;
|
||||
return 500;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers ledger routes for the authenticated user's selected company.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /ledger:
|
||||
* post:
|
||||
* tags: [Ledger]
|
||||
* summary: Add ledger entry
|
||||
* description: |
|
||||
* Appends a new entry to the append-only ledger table.
|
||||
* `hash_version` is fixed to 1. `prev_hash` is cryptographically chained:
|
||||
* for the genesis row it defaults to `TODO_TSE_BASED_INITHASH`, and for subsequent rows
|
||||
* it is the SHA-512 hex hash of the canonical JSON representation of the previous highest-id entry.
|
||||
* Requires authentication and membership in the company owning the referenced manifest article.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/LedgerEntryInput'
|
||||
* example:
|
||||
* manifestarticle_id: 1
|
||||
* transaction_type: 'PAYMENT'
|
||||
* amount: 150.00
|
||||
* transaction_text: 'Payment received for invoice'
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Ledger entry added successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* ledger:
|
||||
* $ref: '#/components/schemas/LedgerEntry'
|
||||
* 400:
|
||||
* description: Invalid ledger entry or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Manifest article or company not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
app.post(`${basePath}/ledger`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const ledger = await db.add(req.user.id, req.body ?? {});
|
||||
res.status(201).json({ ledger });
|
||||
} catch (error) {
|
||||
const status = ledgerErrorStatus(error);
|
||||
if (status === 500) console.error('Add ledger entry failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /ledger/manifestarticle/{manifestarticleId}:
|
||||
* get:
|
||||
* tags: [Ledger]
|
||||
* summary: Query ledger by manifest article ID
|
||||
* description: Lists ledger entries for a specific manifest article line, optionally filtered by transaction type.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: manifestarticleId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Manifest article line ID
|
||||
* - in: query
|
||||
* name: transaction_type
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Optional transaction type filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of ledger entries
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* ledger:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/LedgerEntry'
|
||||
* 400:
|
||||
* description: Invalid manifest article id or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Manifest article or company not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
app.get(`${basePath}/ledger/manifestarticle/:manifestarticleId`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const manifestarticleId = Number(req.params.manifestarticleId);
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
|
||||
try {
|
||||
const ledger = await db.listByManifestarticleId(
|
||||
req.user.id,
|
||||
manifestarticleId,
|
||||
transactionType,
|
||||
);
|
||||
res.status(200).json({ ledger });
|
||||
} catch (error) {
|
||||
const status = ledgerErrorStatus(error);
|
||||
if (status === 500) console.error('Query ledger by manifestarticle failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /ledger/sku/{sku}:
|
||||
* get:
|
||||
* tags: [Ledger]
|
||||
* summary: Query ledger by article SKU
|
||||
* description: Lists ledger entries for an article SKU (joined from manifestarticle), optionally filtered by transaction type.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: sku
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Article SKU
|
||||
* - in: query
|
||||
* name: transaction_type
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Optional transaction type filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of ledger entries
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* ledger:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/LedgerEntry'
|
||||
* 400:
|
||||
* description: Invalid SKU or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Company not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
app.get(`${basePath}/ledger/sku/:sku`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const sku = req.params.sku;
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
|
||||
try {
|
||||
const ledger = await db.listBySku(req.user.id, sku, transactionType);
|
||||
res.status(200).json({ ledger });
|
||||
} catch (error) {
|
||||
const status = ledgerErrorStatus(error);
|
||||
if (status === 500) console.error('Query ledger by sku failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /ledger:
|
||||
* get:
|
||||
* tags: [Ledger]
|
||||
* summary: Query ledger by manifest article ID or SKU
|
||||
* description: |
|
||||
* Alternative query endpoint supporting `?manifestarticle_id=...` or `?sku=...`,
|
||||
* with optional `?transaction_type=...`.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: manifestarticle_id
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Query entries for this manifest article line ID
|
||||
* - in: query
|
||||
* name: sku
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Query entries for this article SKU
|
||||
* - in: query
|
||||
* name: transaction_type
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Optional transaction type filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of ledger entries
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* ledger:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/LedgerEntry'
|
||||
* 400:
|
||||
* description: Missing required query parameter or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
app.get(`${basePath}/ledger`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const rawManifestarticleId = req.query.manifestarticle_id ?? req.query.manifestarticleId;
|
||||
const sku = req.query.sku;
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
|
||||
if (rawManifestarticleId == null && (sku == null || !String(sku).trim())) {
|
||||
return res.status(400).json({
|
||||
error: 'Either manifestarticle_id or sku query parameter is required',
|
||||
});
|
||||
}
|
||||
|
||||
try {
|
||||
let ledger;
|
||||
if (rawManifestarticleId != null) {
|
||||
ledger = await db.listByManifestarticleId(
|
||||
req.user.id,
|
||||
Number(rawManifestarticleId),
|
||||
transactionType,
|
||||
);
|
||||
} else {
|
||||
ledger = await db.listBySku(req.user.id, String(sku).trim(), transactionType);
|
||||
}
|
||||
res.status(200).json({ ledger });
|
||||
} catch (error) {
|
||||
const status = ledgerErrorStatus(error);
|
||||
if (status === 500) console.error('Query ledger failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user