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

u

Browse Source
This commit is contained in:
seb
2026-09-27 21:01:20 +02:00
parent bab15b0978
commit 68b793c9ba
17 changed files with 1695 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/api/openapi.js
View File

@@ -93,9 +93,11 @@
* type: string
* sku:
* type: string
* track_stock:
* type: boolean
* ArticleDetail:
* type: object
* description: Full article payload (unit, brand, categoryIds, photos, eans, prices, …)
* description: Full article payload (unit, brand, categoryIds, photos, eans, prices, track_stock, …)
* additionalProperties: true
* ArticleHistoryEntry:
* type: object
@@ -822,6 +824,34 @@
* desc:
* type: string
* nullable: true
* Warehouse:
* type: object
* required: [id, name, sort]
* properties:
* id:
* type: integer
* name:
* type: string
* sort:
* type: integer
* description: Sort order
* WarehouseCreateInput:
* type: object
* required: [name]
* properties:
* name:
* type: string
* sort:
* type: integer
* description: Optional sort order (defaults to auto-increment)
* WarehouseUpdateInput:
* type: object
* properties:
* name:
* type: string
* sort:
* type: integer
* description: Sort order
* StockAdjustmentInput:
* type: object
* properties:

114
src/api/routes/article.js
View File

@@ -61,6 +61,7 @@ function articleErrorStatus(error) {
if (error.message === 'Company not found') return 404;
if (error.message === 'Brand not found') return 404;
if (error.message === 'Invalid weight') return 400;
if (error.message === 'Invalid track_stock') return 400;
if (error.message === 'Invalid categoryIds') return 400;
if (error.message?.includes('already exists') || error.code === 'SQLITE_CONSTRAINT_UNIQUE') return 409;
return 500;
@@ -96,6 +97,9 @@ export function register(app, basePath = '') {
* description: Category id
* name:
* type: string
* track_stock:
* type: boolean
* description: Whether to track inventory stock (defaults to true)
* example:
* parentId: 10
* name: New article
@@ -151,11 +155,18 @@ export function register(app, basePath = '') {
return res.status(400).json({ error: 'name is required' });
}
const rawTrack = req.body?.track_stock ?? req.body?.trackStock;
if (rawTrack !== undefined && typeof rawTrack !== 'boolean' && rawTrack !== 0 && rawTrack !== 1) {
return res.status(400).json({ error: 'Invalid track_stock' });
}
const track_stock = rawTrack !== undefined ? Boolean(rawTrack) : true;
try {
const article = await db.createUnderParent({
googleAuthId: req.user.id,
parentId: parent.id,
name,
track_stock,
});
emitArticlesSignal(req);
res.status(201).json({ article });
@@ -353,6 +364,9 @@ export function register(app, basePath = '') {
* unitSi:
* type: string
* description: Existing company unit `si`
* track_stock:
* type: boolean
* description: Whether to track inventory stock
* example:
* unitamount: 0.24
* unitSi: l
@@ -550,9 +564,14 @@ export function register(app, basePath = '') {
if (Object.prototype.hasOwnProperty.call(body, 'unitSi')) {
patch.unitSi = body.unitSi;
}
if (Object.prototype.hasOwnProperty.call(body, 'track_stock')) {
patch.track_stock = body.track_stock;
} else if (Object.prototype.hasOwnProperty.call(body, 'trackStock')) {
patch.track_stock = body.trackStock;
}
if (!('name' in patch) && !('unitamount' in patch) && !('unitSi' in patch)) {
return res.status(400).json({ error: 'name, unitamount, or unitSi is required' });
if (!('name' in patch) && !('unitamount' in patch) && !('unitSi' in patch) && !('track_stock' in patch)) {
return res.status(400).json({ error: 'name, unitamount, unitSi, or track_stock is required' });
}
try {
@@ -1218,6 +1237,97 @@ export function register(app, basePath = '') {
}
});
/**
* @openapi
* /article/{sku}/track_stock:
* put:
* tags: [Article]
* summary: Set article track_stock flag by SKU
* description: |
* Enables or disables inventory stock tracking for this article.
* security:
* - cookieAuth: []
* x-signals: [article-<sku>]
* parameters:
* - in: path
* name: sku
* required: true
* schema:
* type: string
* description: Article SKU
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required: [track_stock]
* properties:
* track_stock:
* type: boolean
* description: Whether to track inventory stock for this article
* example:
* track_stock: true
* responses:
* 200:
* description: Updated article detail
* content:
* application/json:
* schema:
* type: object
* properties:
* article:
* $ref: '#/components/schemas/ArticleDetail'
* 400:
* description: Invalid track_stock
* 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: Article not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
async function handleSetTrackStock(req, res) {
const skuParsed = parseSku(req.params.sku);
if (skuParsed.error) {
return res.status(400).json({ error: skuParsed.error });
}
const raw = req.body?.track_stock ?? req.body?.trackStock;
if (raw === undefined || (typeof raw !== 'boolean' && raw !== 0 && raw !== 1)) {
return res.status(400).json({ error: 'Invalid track_stock' });
}
try {
const article = await db.setTrackStockBySku(req.user.id, skuParsed.sku, Boolean(raw));
emitArticleSignal(req, skuParsed.sku);
res.status(200).json({ article });
} catch (error) {
const status = articleErrorStatus(error);
if (status === 500) console.error('Set article track_stock failed:', error);
res.status(status).json({ error: error.message });
}
}
app.put(`${basePath}/article/:sku/track_stock`, handleSetTrackStock);
app.put(`${basePath}/article/:sku/track-stock`, handleSetTrackStock);
/**
* @openapi
* /article/{sku}/categories:

434
src/api/routes/warehouse.js
View File

@@ -9,6 +9,14 @@ function requireSelectedCompany(req) {
return { companyId };
}
function parsePositiveInt(val, field = 'id') {
const id = Number(val);
if (!Number.isInteger(id) || id <= 0) {
return { error: `${field} is required` };
}
return { id };
}
function warehouseErrorStatus(error) {
if (error.message === 'No company selected') return 400;
if (error.message === 'Not authorized') return 403;
@@ -17,6 +25,8 @@ function warehouseErrorStatus(error) {
if (error.message === 'Name required') return 400;
if (error.message === 'Warehouse already exists') return 409;
if (error.message === 'Warehouse in use in ledger') return 409;
if (error.message === 'Invalid warehouse order') return 400;
if (error.message === 'Invalid sort') return 400;
return 500;
}
@@ -26,6 +36,47 @@ function warehouseErrorStatus(error) {
* @param {string} [basePath='']
*/
export function register(app, basePath = '') {
/**
* @openapi
* /warehouse:
* get:
* tags: [Warehouse]
* summary: List warehouses
* description: Lists warehouses for the selected company, ordered by sort and name.
* security:
* - cookieAuth: []
* x-markdown: warehouse/list.md
* responses:
* 200:
* description: List of warehouses
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouses:
* type: array
* items:
* $ref: '#/components/schemas/Warehouse'
* 400:
* description: 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'
*/
app.get(`${basePath}/warehouse`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
@@ -42,19 +93,145 @@ export function register(app, basePath = '') {
}
});
/**
* @openapi
* /warehouse/order:
* put:
* tags: [Warehouse]
* summary: Reorder warehouses
* description: |
* Reorders warehouses for the selected company.
* `warehouseIds` must include all existing warehouse IDs exactly once.
* security:
* - cookieAuth: []
* x-markdown: warehouse/order.md
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required: [warehouseIds]
* properties:
* warehouseIds:
* type: array
* items:
* type: integer
* responses:
* 200:
* description: Applied warehouse order
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouseIds:
* type: array
* items:
* type: integer
* 400:
* description: Invalid warehouse 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'
*/
app.put(`${basePath}/warehouse/order`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const { warehouseIds } = req.body ?? {};
try {
const result = await db.order(req.user.id, { warehouseIds });
emit('warehouse', { companyId: selected.companyId });
res.status(200).json(result);
} catch (error) {
const status = warehouseErrorStatus(error);
if (status === 500) console.error('Order warehouses failed:', error);
res.status(status).json({ error: error.message });
}
});
/**
* @openapi
* /warehouse/{id}:
* get:
* tags: [Warehouse]
* summary: Get warehouse by ID
* description: Retrieves a single warehouse for the authenticated user's selected company.
* security:
* - cookieAuth: []
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: Warehouse ID
* x-markdown: warehouse/get.md
* responses:
* 200:
* description: Warehouse details
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouse:
* $ref: '#/components/schemas/Warehouse'
* 400:
* description: 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: Warehouse not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.get(`${basePath}/warehouse/: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 parsedId = parsePositiveInt(req.params.id, 'id');
if (parsedId.error) {
return res.status(400).json({ error: parsedId.error });
}
try {
const warehouse = await db.getById(req.user.id, id);
const warehouse = await db.getById(req.user.id, parsedId.id);
if (!warehouse) {
return res.status(404).json({ error: 'Warehouse not found' });
}
@@ -66,16 +243,69 @@ export function register(app, basePath = '') {
}
});
/**
* @openapi
* /warehouse:
* post:
* tags: [Warehouse]
* summary: Create warehouse
* description: |
* Creates a new warehouse for the selected company.
* Sort order will be automatically appended if omitted.
* security:
* - cookieAuth: []
* x-markdown: warehouse/create.md
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/WarehouseCreateInput'
* responses:
* 201:
* description: Created warehouse
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouse:
* $ref: '#/components/schemas/Warehouse'
* 400:
* description: Invalid input or missing fields
* 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'
* 409:
* description: Warehouse already exists
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.post(`${basePath}/warehouse`, async (req, res) => {
const selected = requireSelectedCompany(req);
if (selected.error) {
return res.status(400).json({ error: selected.error });
}
const { name } = req.body ?? {};
const { name, sort } = req.body ?? {};
try {
const warehouse = await db.create(req.user.id, { name });
const warehouse = await db.create(req.user.id, { name, sort });
emit('warehouse', { companyId: selected.companyId });
res.status(201).json({ warehouse });
} catch (error) {
@@ -91,15 +321,15 @@ export function register(app, basePath = '') {
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 parsedId = parsePositiveInt(req.params.id, 'id');
if (parsedId.error) {
return res.status(400).json({ error: parsedId.error });
}
const { name } = req.body ?? {};
const { name, sort } = req.body ?? {};
try {
const warehouse = await db.update(req.user.id, id, { name });
const warehouse = await db.update(req.user.id, parsedId.id, { name, sort });
emit('warehouse', { companyId: selected.companyId });
res.status(200).json({ warehouse });
} catch (error) {
@@ -109,22 +339,196 @@ export function register(app, basePath = '') {
}
}
/**
* @openapi
* /warehouse/{id}:
* patch:
* tags: [Warehouse]
* summary: Update warehouse (partial)
* description: Updates specified fields of an existing warehouse for the selected company.
* security:
* - cookieAuth: []
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: Warehouse ID
* x-markdown: warehouse/update.md
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/WarehouseUpdateInput'
* responses:
* 200:
* description: Updated warehouse
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouse:
* $ref: '#/components/schemas/Warehouse'
* 400:
* description: Invalid input
* 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: Warehouse not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Warehouse name conflict
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* put:
* tags: [Warehouse]
* summary: Update warehouse
* description: Updates specified fields of an existing warehouse for the selected company.
* security:
* - cookieAuth: []
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: Warehouse ID
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/WarehouseUpdateInput'
* responses:
* 200:
* description: Updated warehouse
* content:
* application/json:
* schema:
* type: object
* properties:
* warehouse:
* $ref: '#/components/schemas/Warehouse'
* 400:
* description: Invalid input
* 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: Warehouse not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Warehouse name conflict
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.patch(`${basePath}/warehouse/:id`, handleUpdate);
app.put(`${basePath}/warehouse/:id`, handleUpdate);
/**
* @openapi
* /warehouse/{id}:
* delete:
* tags: [Warehouse]
* summary: Delete warehouse
* description: Deletes a warehouse if not in use in the ledger.
* security:
* - cookieAuth: []
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: Warehouse ID
* x-markdown: warehouse/delete.md
* responses:
* 204:
* description: Warehouse deleted
* 400:
* description: 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: Warehouse not found
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Warehouse in use in ledger
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
app.delete(`${basePath}/warehouse/: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 parsedId = parsePositiveInt(req.params.id, 'id');
if (parsedId.error) {
return res.status(400).json({ error: parsedId.error });
}
try {
await db.remove(req.user.id, id);
await db.remove(req.user.id, parsedId.id);
emit('warehouse', { companyId: selected.companyId });
res.sendStatus(204);
} catch (error) {