seb/dashback
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add customergroup and entity HTTP APIs with address and contact routes.

Browse Source 
Expose store-backed CRUD for customer groups, entities, nested addresses, and contacts, matching the documented dashdbschema contracts.
This commit is contained in:
seb
2026-08-06 07:38:05 +02:00
parent 1860f38640
commit 74269cd3ef
30 changed files with 4166 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

414
src/api/routes/entity.js Normal file
View File

@@ -0,0 +1,414 @@
import * as db from '../../db/entity.js';
function requireSelectedCompany(req) {
const companyId = req.user.selectedCompanyId;
if (companyId == null) {
return { error: 'No company selected' };
}
return { companyId };
}
function entityErrorStatus(error) {
if (error.message === 'Not authorized') return 403;
if (error.message === 'Company not found') return 404;
if (error.message === 'Entity not found') return 404;
if (error.message === 'Customer group not found') return 404;
if (error.message === 'Name required') return 400;
return 500;
}
/**
* Registers entity routes for the authenticated user's selected company.
* @param {import('express').Application} app
* @param {string} [basePath='']
*/
export function register(app, basePath = '') {
/**
* @openapi
* /entity:
* get:
* tags: [Entity]
* summary: List entities
* description: |
* Lists entities for the selected company. Optional `customergroupId`
* query filters to one group (must belong to the company).
* security:
* - cookieAuth: []
* x-markdown: entity/list.md
* parameters:
* - in: query
* name: customergroupId
* required: false
* schema:
* type: integer
* responses:
* 200:
* description: Entity list
* content:
* application/json:
* schema:
* type: object
* properties:
* entities:
* type: array
* items:
* $ref: '#/components/schemas/Entity'
* 400:
* description: No company selected or invalid customergroupId
* 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 or customer group not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* post:
* tags: [Entity]
* summary: Create entity
* description: |
* Creates an entity in a company customer group and writes `entityhistory` (`Erstellt`).
* security:
* - cookieAuth: []
* x-markdown: entity/create.md
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required: [customergroupId, name]
* properties:
* customergroupId:
* type: integer
* name:
* type: string
* firstName:
* type: string
* nullable: true
* example:
* customergroupId: 1
* name: Müller
* firstName: Anna
* responses:
* 201:
* description: Created entity
* content:
* application/json:
* schema:
* type: object
* properties:
* entity:
* $ref: '#/components/schemas/Entity'
* 400:
* description: Name required 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 or customer group not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.get(`${basePath}/entity`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const options = {};
if (Object.prototype.hasOwnProperty.call(req.query, 'customergroupId')) {
const customergroupId = Number(req.query.customergroupId);
if (!Number.isInteger(customergroupId) || customergroupId <= 0) {
return res.status(400).json({ error: 'customergroupId is invalid' });
}
options.customergroupId = customergroupId;
}
try {
const entities = await db.list(req.user.id, selected.companyId, options);
res.status(200).json({ entities });
} catch (error) {
const status = entityErrorStatus(error);
if (status === 500) console.error('List entities failed:', error);
res.status(status).json({ error: error.message });
}
});
app.post(`${basePath}/entity`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const { customergroupId, name, firstName } = req.body ?? {};
try {
const entity = await db.create(req.user.id, selected.companyId, {
customergroupId,
name,
firstName,
});
res.status(201).json({ entity });
} catch (error) {
const status = entityErrorStatus(error);
if (status === 500) console.error('Create entity failed:', error);
res.status(status).json({ error: error.message });
}
});
/**
* @openapi
* /entity/{id}:
* get:
* tags: [Entity]
* summary: Get entity
* description: Returns one entity for the selected company.
* security:
* - cookieAuth: []
* x-markdown: entity/get.md
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* responses:
* 200:
* description: Entity
* content:
* application/json:
* schema:
* type: object
* properties:
* entity:
* $ref: '#/components/schemas/Entity'
* 400:
* description: No company selected or invalid id
* 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: Entity or company not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* patch:
* tags: [Entity]
* summary: Update entity
* description: |
* Patches `name` and/or `firstName`. Writes `entityhistory` when values change.
* security:
* - cookieAuth: []
* x-markdown: entity/update.md
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* name:
* type: string
* firstName:
* type: string
* nullable: true
* example:
* name: Müller
* firstName: Anna
* responses:
* 200:
* description: Updated entity
* content:
* application/json:
* schema:
* type: object
* properties:
* entity:
* $ref: '#/components/schemas/Entity'
* 400:
* description: Name required, invalid 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: Entity or company not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* delete:
* tags: [Entity]
* summary: Delete entity
* description: Deletes the entity (`entityhistory` cascades; related addresses/contacts cascade).
* security:
* - cookieAuth: []
* x-markdown: entity/delete.md
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* responses:
* 204:
* description: Deleted
* 400:
* description: No company selected or invalid id
* 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: Entity not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.get(`${basePath}/entity/:id`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const id = Number(req.params.id);
if (!Number.isInteger(id) || id <= 0) {
return res.status(400).json({ error: 'id is required' });
}
try {
const entity = await db.getById(req.user.id, selected.companyId, id);
res.status(200).json({ entity });
} catch (error) {
const status = entityErrorStatus(error);
if (status === 500) console.error('Get entity failed:', error);
res.status(status).json({ error: error.message });
}
});
app.patch(`${basePath}/entity/:id`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const id = Number(req.params.id);
if (!Number.isInteger(id) || id <= 0) {
return res.status(400).json({ error: 'id is required' });
}
const body = req.body ?? {};
const patch = {};
if (Object.prototype.hasOwnProperty.call(body, 'name')) {
patch.name = body.name;
}
if (Object.prototype.hasOwnProperty.call(body, 'firstName')) {
patch.firstName = body.firstName;
}
try {
const entity = await db.update(req.user.id, selected.companyId, id, patch);
res.status(200).json({ entity });
} catch (error) {
const status = entityErrorStatus(error);
if (status === 500) console.error('Update entity failed:', error);
res.status(status).json({ error: error.message });
}
});
app.delete(`${basePath}/entity/:id`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const id = Number(req.params.id);
if (!Number.isInteger(id) || id <= 0) {
return res.status(400).json({ error: 'id is required' });
}
try {
await db.remove(req.user.id, selected.companyId, id);
res.sendStatus(204);
} catch (error) {
const status = entityErrorStatus(error);
if (status === 500) console.error('Delete entity failed:', error);
res.status(status).json({ error: error.message });
}
});
}