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

Add customergroup bulk reorder and list editable flag.

Browse Source 
Expose PUT /customergroup/order for exact-set sort updates, keep create/update name-only, and mark POS/Lieferanten as non-editable in list responses.
This commit is contained in:
seb
2026-08-07 03:40:40 +02:00
parent cdae7b6eab
commit 57fd3b4837
9 changed files with 344 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/api/openapi.js
View File

@@ -126,12 +126,26 @@
* format: date-time
* Customergroup:
* type: object
* required: [id, name]
* required: [id, name, sort]
* properties:
* id:
* type: integer
* name:
* type: string
* sort:
* type: integer
* CustomergroupListItem:
* allOf:
* - $ref: '#/components/schemas/Customergroup'
* - type: object
* required: [editable]
* properties:
* editable:
* type: boolean
* description: |
* `false` for implicit groups `POS` and `Lieferanten` (name locked).
* `true` for user-created groups. Reorder all groups via
* `PUT /customergroup/order`.
* Entity:
* type: object
* required: [id, customergroupId, firstName, name, createdAt, updatedAt]

130
src/api/routes/customergroup.js
View File

@@ -1,5 +1,8 @@
import * as db from '../../db/customergroup.js';
/** Implicit groups created by the system — name locked. */
const LOCKED_NAMES = new Set(['POS', 'Lieferanten']);
function requireSelectedCompany(req) {
const companyId = req.user.selectedCompanyId;
if (companyId == null) {
@@ -13,10 +16,20 @@ function customergroupErrorStatus(error) {
if (error.message === 'Company not found') return 404;
if (error.message === 'Customer group not found') return 404;
if (error.message === 'Name required') return 400;
if (error.message === 'Name not allowed') return 400;
if (error.message === 'Name cannot be changed') return 400;
if (error.message === 'Invalid customer group order') return 400;
if (error.message === 'Customer group in use') return 409;
return 500;
}
function withEditable(row) {
return {
...row,
editable: !LOCKED_NAMES.has(row.name),
};
}
/**
* Registers customergroup routes for the authenticated user's selected company.
* @param {import('express').Application} app
@@ -29,7 +42,10 @@ export function register(app, basePath = '') {
* get:
* tags: [Customergroup]
* summary: List customer groups
* description: Lists customer groups for the authenticated user's selected company.
* description: |
* Lists customer groups for the selected company, ordered by `sort`.
* Each item includes `editable`: `false` for implicit `POS` / `Lieferanten`
* (name locked), `true` otherwise. Reorder via `PUT /customergroup/order`.
* security:
* - cookieAuth: []
* x-markdown: customergroup/list.md
@@ -44,7 +60,7 @@ export function register(app, basePath = '') {
* customergroups:
* type: array
* items:
* $ref: '#/components/schemas/Customergroup'
* $ref: '#/components/schemas/CustomergroupListItem'
* 400:
* description: No company selected
* content:
@@ -72,7 +88,10 @@ export function register(app, basePath = '') {
* post:
* tags: [Customergroup]
* summary: Create customer group
* description: Creates a customer group for the selected company.
* description: |
* Creates a customer group for the selected company.
* Appends with the next `sort` index. Reserved names `POS` and `Lieferanten`
* are not allowed (`Name not allowed`).
* security:
* - cookieAuth: []
* x-markdown: customergroup/create.md
@@ -99,7 +118,7 @@ export function register(app, basePath = '') {
* customergroup:
* $ref: '#/components/schemas/Customergroup'
* 400:
* description: Name required or no company selected
* description: Name required, name not allowed, or no company selected
* content:
* application/json:
* schema:
@@ -130,8 +149,8 @@ export function register(app, basePath = '') {
}
try {
const customergroups = await db.list(req.user.id, selected.companyId);
res.status(200).json({ customergroups });
const rows = await db.list(req.user.id, selected.companyId);
res.status(200).json({ customergroups: rows.map(withEditable) });
} catch (error) {
const status = customergroupErrorStatus(error);
if (status === 500) console.error('List customergroups failed:', error);
@@ -157,13 +176,108 @@ export function register(app, basePath = '') {
}
});
/**
* @openapi
* /customergroup/order:
* put:
* tags: [Customergroup]
* summary: Reorder customer groups
* description: |
* Sets `sort` to each id’s index `0…n-1` in one transaction.
* `customergroupIds` must be exactly the company’s groups (same set, no dups)
* else `Invalid customer group order`.
* security:
* - cookieAuth: []
* x-markdown: customergroup/order.md
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required: [customergroupIds]
* properties:
* customergroupIds:
* type: array
* items:
* type: integer
* example:
* customergroupIds: [4, 3, 1, 2]
* responses:
* 200:
* description: New order
* content:
* application/json:
* schema:
* type: object
* properties:
* customergroupIds:
* type: array
* items:
* type: integer
* 400:
* description: Invalid customer group order 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.put(`${basePath}/customergroup/order`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const rawIds = req.body?.customergroupIds;
if (!Array.isArray(rawIds)) {
return res.status(400).json({ error: 'customergroupIds is required' });
}
const customergroupIds = [];
for (const value of rawIds) {
const id = Number(value);
if (!Number.isInteger(id) || id <= 0) {
return res.status(400).json({ error: 'customergroupIds must be positive integers' });
}
customergroupIds.push(id);
}
try {
const result = await db.order(req.user.id, selected.companyId, { customergroupIds });
res.status(200).json(result);
} catch (error) {
const status = customergroupErrorStatus(error);
if (status === 500) console.error('Order customergroups failed:', error);
res.status(status).json({ error: error.message });
}
});
/**
* @openapi
* /customergroup/{id}:
* patch:
* tags: [Customergroup]
* summary: Update customer group
* description: Renames a customer group for the selected company.
* description: |
* Renames a customer group. Implicit `POS` / `Lieferanten` cannot be
* renamed (`Name cannot be changed`). Reorder via `PUT /customergroup/order`.
* security:
* - cookieAuth: []
* x-markdown: customergroup/update.md
@@ -196,7 +310,7 @@ export function register(app, basePath = '') {
* customergroup:
* $ref: '#/components/schemas/Customergroup'
* 400:
* description: Name required, invalid id, or no company selected
* description: Name required, name cannot be changed, invalid id, or no company selected
* content:
* application/json:
* schema:

5
src/db/customergroup.js
View File

@@ -15,6 +15,11 @@ export async function update(googleAuthId, companyId, id, data) {
return store.customergroup.update(googleAuthId, companyId, id, data);
}
export async function order(googleAuthId, companyId, data) {
const store = await getStore();
return store.customergroup.order(googleAuthId, companyId, data);
}
export async function remove(googleAuthId, companyId, id) {
const store = await getStore();
return store.customergroup.delete(googleAuthId, companyId, id);