Compare commits
61 Commits
1c5385061c
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
2a45b43f50 | ||
|
|
9f61c7dee2 | ||
|
|
980578e1e4 | ||
|
|
ce4dc15aac | ||
|
|
da785da2dd | ||
|
|
24563964a6 | ||
|
|
44e91a6973 | ||
|
|
de2957acf1 | ||
|
|
17df88ced5 | ||
|
|
d3209d73c1 | ||
|
|
518106ede2 | ||
|
|
833cee5040 | ||
|
|
aeb79c1acb | ||
|
|
ff185a59dd | ||
|
|
689f12ba69 | ||
|
|
bf081f875d | ||
|
|
8f9c941699 | ||
|
|
e6c15dd053 | ||
|
|
8a5a307c50 | ||
|
|
43d7049a7b | ||
|
|
c60b899c4d | ||
|
|
e8a5322775 | ||
|
|
cb30352b57 | ||
|
|
5d6b31de15 | ||
|
|
8827d6fc14 | ||
|
|
16f70603bc | ||
|
|
ce7f5aad2a | ||
|
|
26adfc5aa9 | ||
|
|
0480a5dcbe | ||
|
|
dd5c9646b3 | ||
|
|
5a0b603306 | ||
|
|
72d05a34d0 | ||
|
|
8fece9d916 | ||
|
|
5fac537268 | ||
|
|
61529023b0 | ||
|
|
2df7c59feb | ||
|
|
02301ff172 | ||
|
|
ab6fcc107f | ||
|
|
bc1340419c | ||
|
|
fbe3105dc9 | ||
|
|
e82ea15d02 | ||
|
|
527e55fec2 | ||
|
|
e1d27b44a7 | ||
|
|
a7258abf35 | ||
|
|
1b432cb6c6 | ||
|
|
0303f8121c | ||
|
|
d151bb5fe3 | ||
|
|
676a40d4fe | ||
|
|
005b48ff66 | ||
|
|
72e6e79d20 | ||
|
|
6a80473594 | ||
|
|
bcdfba1742 | ||
|
|
907ee998c0 | ||
|
|
158748c5e6 | ||
|
|
dc9fcdad96 | ||
|
|
116b51f0a9 | ||
|
|
c937bad151 | ||
|
|
1881830b0a | ||
|
|
01d6aa0e3f | ||
|
|
ff73750092 | ||
|
|
e7884c03ef |
@@ -17,6 +17,7 @@ CORS_ORIGINS=http://localhost:5173
|
||||
# Auth — Google OAuth client ID and JWT signing secret
|
||||
GOOGLE_CLIENT_ID=
|
||||
JWT_SECRET=fallback_secret_please_change_in_production
|
||||
# Auto-create user on first login (when false, only allowlisted or invited emails can sign in / create an account)
|
||||
IMPLICIT_CREATE=false
|
||||
|
||||
# Database Provider — 'sqlite' or 'mssql' (defaults to 'mssql', or 'sqlite' if SQLITE_PATH is set)
|
||||
|
||||
12
Dockerfile
12
Dockerfile
@@ -1,22 +1,20 @@
|
||||
# syntax=docker/dockerfile:1
|
||||
FROM debian:12-slim AS syslibs
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
libatomic1 libuuid1 libfontconfig1 libxml2 libfribidi0 \
|
||||
libatomic1 libuuid1 \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
FROM gcr.io/distroless/cc-debian12
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Shared dynamic libraries needed by Node.js SEA and native addons (canvas, better-sqlite3)
|
||||
# Shared dynamic libraries needed by Node.js SEA and native addons (better-sqlite3)
|
||||
COPY --from=syslibs /usr/lib/x86_64-linux-gnu/libatomic.so* /usr/lib/x86_64-linux-gnu/
|
||||
COPY --from=syslibs /usr/lib/x86_64-linux-gnu/libuuid.so* /usr/lib/x86_64-linux-gnu/
|
||||
COPY --from=syslibs /usr/lib/x86_64-linux-gnu/libfontconfig.so* /usr/lib/x86_64-linux-gnu/
|
||||
COPY --from=syslibs /usr/lib/x86_64-linux-gnu/libxml2.so* /usr/lib/x86_64-linux-gnu/
|
||||
COPY --from=syslibs /usr/lib/x86_64-linux-gnu/libfribidi.so* /usr/lib/x86_64-linux-gnu/
|
||||
|
||||
# Set production defaults: port 4208
|
||||
ENV NODE_ENV=production \
|
||||
ENV RUNNING_IN_DOCKER=true \
|
||||
NODE_ENV=production \
|
||||
HOST=0.0.0.0 \
|
||||
PORT=4208 \
|
||||
HTTPS_PORT=0 \
|
||||
@@ -24,6 +22,4 @@ ENV NODE_ENV=production \
|
||||
STORAGE_DIR=/app/data/storage \
|
||||
BACKUP_DIR=/app/data/backups
|
||||
|
||||
EXPOSE 4208
|
||||
|
||||
CMD ["./dist/dashback"]
|
||||
|
||||
@@ -37,6 +37,15 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/account.get.md`](routes/account.get.md) | `GET /account` |
|
||||
| [`routes/account.post.md`](routes/account.post.md) | `POST /account` |
|
||||
| [`routes/account/_id.md`](routes/account/_id.md) | `DELETE /account/{id}` |
|
||||
| [`routes/agent/events.md`](routes/agent/events.md) | `GET /agent/events` |
|
||||
| [`routes/agent/pair.get.md`](routes/agent/pair.get.md) | `GET /agent/pair` |
|
||||
| [`routes/agent/pair.post.md`](routes/agent/pair.post.md) | `POST /agent/pair` |
|
||||
| [`routes/agent/state.md`](routes/agent/state.md) | `POST /agent/state` |
|
||||
| [`routes/agentprinter.md`](routes/agentprinter.md) | `GET /agentprinter` |
|
||||
| [`routes/agentprinter/order.md`](routes/agentprinter/order.md) | `PUT /agentprinter/order` |
|
||||
| [`routes/agentprinter/_id.delete.md`](routes/agentprinter/_id.delete.md) | `DELETE /agentprinter/{id}` |
|
||||
| [`routes/agentprinter/_id.get.md`](routes/agentprinter/_id.get.md) | `GET /agentprinter/{id}` |
|
||||
| [`routes/agentprinter/_id.patch.md`](routes/agentprinter/_id.patch.md) | `PATCH /agentprinter/{id}` |
|
||||
| [`routes/article/create.md`](routes/article/create.md) | `POST /article` |
|
||||
| [`routes/article/export.zip.md`](routes/article/export.zip.md) | `GET /article/export.zip` |
|
||||
| [`routes/article/history-list.md`](routes/article/history-list.md) | `GET /article/history` |
|
||||
@@ -89,6 +98,9 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/auth/logout.md`](routes/auth/logout.md) | `POST /auth/logout` |
|
||||
| [`routes/auth/me.md`](routes/auth/me.md) | `GET /auth/me` |
|
||||
| [`routes/auth/selected-company.md`](routes/auth/selected-company.md) | `PUT /auth/selected-company` |
|
||||
| [`routes/autoinvite/list.md`](routes/autoinvite/list.md) | `GET /autoinvite` |
|
||||
| [`routes/autoinvite/create.md`](routes/autoinvite/create.md) | `POST /autoinvite` |
|
||||
| [`routes/autoinvite/delete.md`](routes/autoinvite/delete.md) | `DELETE /autoinvite/{id}` |
|
||||
| [`routes/backup.md`](routes/backup.md) | `GET /backup` |
|
||||
| [`routes/backup/_id/vfs.md`](routes/backup/_id/vfs.md) | `GET /backup/{id}/vfs` |
|
||||
| [`routes/backup/_id/vfs/recover.md`](routes/backup/_id/vfs/recover.md) | `POST /backup/{id}/vfs/recover` |
|
||||
@@ -131,6 +143,10 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/companysetting/set.md`](routes/companysetting/set.md) | `PUT /company/setting/{key}` |
|
||||
| [`routes/company/delete.md`](routes/company/delete.md) | `DELETE /company/{id}` |
|
||||
| [`routes/company/update.md`](routes/company/update.md) | `PUT /company/{id}` |
|
||||
| [`routes/companyuser/list.md`](routes/companyuser/list.md) | `GET /companyuser` |
|
||||
| [`routes/companyuser/create.md`](routes/companyuser/create.md) | `POST /companyuser` |
|
||||
| [`routes/companyuser/delete.md`](routes/companyuser/delete.md) | `DELETE /companyuser/{id}` |
|
||||
| [`routes/companyuser/update.md`](routes/companyuser/update.md) | `PATCH /companyuser/{id}` |
|
||||
| [`routes/customergroup/list.md`](routes/customergroup/list.md) | `GET /customergroup` |
|
||||
| [`routes/customergroup/create.md`](routes/customergroup/create.md) | `POST /customergroup` |
|
||||
| [`routes/customergroup/order.md`](routes/customergroup/order.md) | `PUT /customergroup/order` |
|
||||
@@ -164,6 +180,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/image/get.md`](routes/image/get.md) | `GET /image/{fullHash}` |
|
||||
| [`routes/labeltemplate/list.md`](routes/labeltemplate/list.md) | `GET /labeltemplate` |
|
||||
| [`routes/labeltemplate/create.md`](routes/labeltemplate/create.md) | `POST /labeltemplate` |
|
||||
| [`routes/labeltemplate/testprint.md`](routes/labeltemplate/testprint.md) | `POST /labeltemplate/testprint` |
|
||||
| [`routes/labeltemplate/delete.md`](routes/labeltemplate/delete.md) | `DELETE /labeltemplate/{id}` |
|
||||
| [`routes/labeltemplate/get.md`](routes/labeltemplate/get.md) | `GET /labeltemplate/{id}` |
|
||||
| [`routes/labeltemplate/update.md`](routes/labeltemplate/update.md) | `PATCH /labeltemplate/{id}` |
|
||||
@@ -219,10 +236,22 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/printer/list.md`](routes/printer/list.md) | `GET /printer` |
|
||||
| [`routes/printer/create.md`](routes/printer/create.md) | `POST /printer` |
|
||||
| [`routes/printer/order.md`](routes/printer/order.md) | `PUT /printer/order` |
|
||||
| [`routes/printer/state.md`](routes/printer/state.md) | `GET /printer/state` |
|
||||
| [`routes/printer/delete.md`](routes/printer/delete.md) | `DELETE /printer/{id}` |
|
||||
| [`routes/printer/get.md`](routes/printer/get.md) | `GET /printer/{id}` |
|
||||
| [`routes/printer/update.md`](routes/printer/update.md) | `PATCH /printer/{id}` |
|
||||
| [`routes/printer/_id.put.md`](routes/printer/_id.put.md) | `PUT /printer/{id}` |
|
||||
| [`routes/printer/_id/state.md`](routes/printer/_id/state.md) | `GET /printer/{id}/state` |
|
||||
| [`routes/printeragent.get.md`](routes/printeragent.get.md) | `GET /printeragent` |
|
||||
| [`routes/printeragent.put.md`](routes/printeragent.put.md) | `PUT /printeragent` |
|
||||
| [`routes/printeragent/_id.delete.md`](routes/printeragent/_id.delete.md) | `DELETE /printeragent/{id}` |
|
||||
| [`routes/printeragent/_id.patch.md`](routes/printeragent/_id.patch.md) | `PATCH /printeragent/{id}` |
|
||||
| [`routes/printerjob.get.md`](routes/printerjob.get.md) | `GET /printerjob` |
|
||||
| [`routes/printerjob.post.md`](routes/printerjob.post.md) | `POST /printerjob` |
|
||||
| [`routes/printerjob/cancel-all.md`](routes/printerjob/cancel-all.md) | `POST /printerjob/cancel-all` |
|
||||
| [`routes/printerjob/_id.delete.md`](routes/printerjob/_id.delete.md) | `DELETE /printerjob/{id}` |
|
||||
| [`routes/printerjob/_id.get.md`](routes/printerjob/_id.get.md) | `GET /printerjob/{id}` |
|
||||
| [`routes/printerjob/_id/cancel.md`](routes/printerjob/_id/cancel.md) | `POST /printerjob/{id}/cancel` |
|
||||
| [`routes/propertyname.get.md`](routes/propertyname.get.md) | `GET /propertyname` |
|
||||
| [`routes/propertyname.post.md`](routes/propertyname.post.md) | `POST /propertyname` |
|
||||
| [`routes/propertyname/order.md`](routes/propertyname/order.md) | `PUT /propertyname/order` |
|
||||
@@ -316,6 +345,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/warehouse/get.md`](routes/warehouse/get.md) | `GET /warehouse/{id}` |
|
||||
| [`routes/warehouse/update.md`](routes/warehouse/update.md) | `PATCH /warehouse/{id}` |
|
||||
| [`routes/warehouse/_id.put.md`](routes/warehouse/_id.put.md) | `PUT /warehouse/{id}` |
|
||||
| [`routes/zpljob.md`](routes/zpljob.md) | `POST /zpljob` |
|
||||
|
||||
Route overview: [`routes.md`](routes.md) | All routes: [`routes-all.md`](routes-all.md).
|
||||
|
||||
@@ -325,13 +355,16 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A
|
||||
|
||||
| Signal | Emitted by |
|
||||
|--------|------------|
|
||||
| `agentprinter` | `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, `PATCH /agentprinter/{id}` |
|
||||
| `article-<sku>` | `PUT /article/{sku}/brand`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/eans`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}`, `PUT /article/{sku}/images/order`, `PUT /article/{sku}/prices`, `POST /article/{sku}/supplier`, `PUT /article/{sku}/supplier/order`, `DELETE /article/{sku}/supplier/{id}`, `PATCH /article/{sku}/supplier/{id}`, `PUT /article/{sku}/track_stock`, `PUT /article/{sku}/weight`, `POST /stock/adjust` |
|
||||
| `articles` | `POST /article`, `DELETE /article/{sku}`, `PATCH /article/{sku}`, `DELETE /category/{id}`, `DELETE /shipment/{id}`, `POST /stock/accept`, `POST /stock/adjust`, `POST /stock/ship` |
|
||||
| `attributename` | `POST /attributename`, `PUT /attributename/order`, `DELETE /attributename/{id}`, `PATCH /attributename/{id}`, `DELETE /attributevalue/{id}/image`, `POST /attributevalue/{id}/image` |
|
||||
| `autoinvite` | `POST /autoinvite`, `DELETE /autoinvite/{id}` |
|
||||
| `brand` | `POST /brand`, `DELETE /brand/{id}`, `PATCH /brand/{id}`, `DELETE /brand/{id}/image`, `POST /brand/{id}/image` |
|
||||
| `carrier` | `POST /carrier`, `PUT /carrier/order`, `DELETE /carrier/{id}`, `PATCH /carrier/{id}` |
|
||||
| `category` | `POST /category`, `PUT /category/order`, `DELETE /category/{id}`, `PATCH /category/{id}`, `DELETE /category/{id}/image`, `POST /category/{id}/image`, `POST /category/{id}/image/generate` |
|
||||
| `company` | `PUT /auth/selected-company`, `POST /company`, `DELETE /company/{id}`, `PUT /company/{id}` |
|
||||
| `companyuser` | `POST /companyuser`, `DELETE /companyuser/{id}`, `PATCH /companyuser/{id}` |
|
||||
| `delivery` | `DELETE /delivery/{id}/file/{fileId}`, `POST /delivery/{id}/pdf`, `POST /stock/accept` |
|
||||
| `labeltemplate` | `POST /labeltemplate`, `DELETE /labeltemplate/{id}`, `PATCH /labeltemplate/{id}`, `PUT /labeltemplate/{id}` |
|
||||
| `ledger` | `DELETE /shipment/{id}`, `POST /stock/accept`, `POST /stock/adjust`, `POST /stock/ship` |
|
||||
@@ -345,6 +378,8 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A
|
||||
| `shipping` | `POST /stock/ship` |
|
||||
| `stock` | `DELETE /shipment/{id}`, `POST /stock/accept`, `POST /stock/adjust`, `POST /stock/ship` |
|
||||
| `subagentschedule` | `POST /subagentschedule`, `DELETE /subagentschedule/{id}`, `PUT /subagentschedule/{id}` |
|
||||
| `supplier` | `POST /supplier`, `DELETE /supplier/{id}`, `PATCH /supplier/{id}` |
|
||||
| `user` | `PUT /auth/selected-company`, `POST /company`, `DELETE /company/{id}` |
|
||||
| `vfs` | `POST /vfs/applets/restore`, `POST /vfs/mkdir`, `POST /vfs/rename`, `POST /vfs/skills/restore`, `POST /vfs/upload`, `DELETE /vfs/{*path}`, `POST /vfs/{*path}`, `PUT /vfs/{*path}` |
|
||||
| `warehouse` | `POST /warehouse`, `PUT /warehouse/order`, `DELETE /warehouse/{id}`, `PUT /warehouse/{id}` |
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 284 API endpoints across all modules.
|
||||
Overview of all 314 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -9,44 +9,48 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
|
||||
### Reusable types
|
||||
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T18[], externalNumber?: str|null, createdAt?: str, shipping?: T20|null, shippings?: T20[], payment?: T29|null, payments?: T29[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T9[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T18[], shippings: T20[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T9[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T18[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T9[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T21[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T36 }`
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T20[], externalNumber?: str|null, createdAt?: str, shipping?: T23|null, shippings?: T23[], payment?: T33|null, payments?: T33[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T10[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T20[], shippings: T23[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T10[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T20[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T10[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T24[], files: T10[], externalNumber?: str|null, createdAt?: str, ledger?: T40 }`
|
||||
- `T5` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T6|null }`
|
||||
- `T6` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T11, totalSizeBytes: int, durationMs: int }`
|
||||
- `T7` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T38|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T8` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T22[] }, thumb?: str|null }`
|
||||
- `T9` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }`
|
||||
- `T10` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }`
|
||||
- `T11` = `{ vfs: T37, storage: T37, database: T31 }`
|
||||
- `T12` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }`
|
||||
- `T13` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }`
|
||||
- `T14` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }`
|
||||
- `T15` = `{ id: int, name: str, sort: int, exclusive: bool, values: T27[], articleCount?: int }`
|
||||
- `T16` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }`
|
||||
- `T17` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }`
|
||||
- `T18` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T19` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T20` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T21` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T22` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T23` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T24` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T25` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }`
|
||||
- `T26` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T27` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T28` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T29` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T30` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T31` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }`
|
||||
- `T32` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }`
|
||||
- `T33` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T34` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T35` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T36` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T37` = `{ name: str, sizeBytes: int, sourceExists: bool }`
|
||||
- `T38` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
- `T7` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, sort?: int, enabled?: bool, clientversion?: str|null, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }`
|
||||
- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T42|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T9` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T25[] }, thumb?: str|null }`
|
||||
- `T10` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }`
|
||||
- `T11` = `{ vfs: T41, storage: T41, database: T35 }`
|
||||
- `T12` = `{ id: int, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int, enabled?: bool }`
|
||||
- `T13` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null, open?: bool, pause?: bool, error?: bool, online?: bool, labelLength?: int|null }`
|
||||
- `T14` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }`
|
||||
- `T15` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }`
|
||||
- `T16` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }`
|
||||
- `T17` = `{ id: int, name: str, sort: int, exclusive: bool, values: T30[], articleCount?: int }`
|
||||
- `T18` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }`
|
||||
- `T19` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num, role: str }`
|
||||
- `T20` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T21` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T22` = `{ id: int, agentprinterId: int, type: str, state: str, data: str, createdAt: str, printeragentId?: int|null, completedAt?: str|null }`
|
||||
- `T23` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T24` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T25` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T26` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T27` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T28` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }`
|
||||
- `T29` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T30` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T31` = `{ id: int, googleAuthId: int, email: str, role: str, picture?: str|null }`
|
||||
- `T32` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T33` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T34` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T35` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }`
|
||||
- `T36` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }`
|
||||
- `T37` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T38` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T39` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T40` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T41` = `{ name: str, sizeBytes: int, sourceExists: bool }`
|
||||
- `T42` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
|
||||
### Routes
|
||||
|
||||
@@ -72,6 +76,39 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
|
||||
### Section: /agent
|
||||
|
||||
#### Printer agent SSE stream — `GET /agent/events`
|
||||
- Params: `query: token?: str, agentversion?: str`
|
||||
- Returns: `200 SSE`
|
||||
#### Pair printer agent via query parameters — `GET /agent/pair`
|
||||
- Params: `query: authCode?: str, pairingpin?: str, serial?: str, model?: str, version?: str`
|
||||
- Returns: `200`
|
||||
#### Pair printer agent — `POST /agent/pair`
|
||||
- Params: `body: { pairingpin: str, clientserial?: str, clientmodel?: str, agentversion?: str }`
|
||||
- Returns: `200 { id: int, name: str, companyId: int, token: str, pairedAt: str, clientserial: str|null, clientmodel: str|null, agentversion: str|null, sort: int }`
|
||||
#### Post agent state — `POST /agent/state`
|
||||
- Params: `body: { state?: any }`
|
||||
- Returns: `200 { success: bool, agent: T12 }`
|
||||
|
||||
### Section: /agentprinter
|
||||
|
||||
#### List agent printers — `GET /agentprinter`
|
||||
- Params: `query: printeragentId?: int`
|
||||
- Returns: `200 { agentprinters: T13[] }`
|
||||
#### Reorder agent printers — `PUT /agentprinter/order`
|
||||
- Params: `body: { agentprinterIds: int[], printeragentId?: int }`
|
||||
- Returns: `200 { agentprinterIds: int[] }`
|
||||
#### Delete agent printer — `DELETE /agentprinter/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get agent printer — `GET /agentprinter/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { agentprinter: T13 }`
|
||||
#### Update agent printer — `PATCH /agentprinter/{id}`
|
||||
- Params: `id: int, body: { enabled?: bool, sort?: int }`
|
||||
- Returns: `200 { agentprinter: T13 }`
|
||||
|
||||
### Section: /article
|
||||
|
||||
#### Create article in category — `POST /article`
|
||||
@@ -88,7 +125,7 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Get article by SKU — `GET /article/{sku}`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T26, brand: T25|null, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T7[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T29, brand: T28|null, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T8[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }`
|
||||
#### Update article by SKU — `PATCH /article/{sku}`
|
||||
- Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }`
|
||||
- Returns: `204 void`
|
||||
@@ -146,11 +183,11 @@ _none_
|
||||
#### Toggle parent mode for an article — `POST /article/{sku}/parent`
|
||||
- Params: `sku: str, body: { isParent: bool, attributeNameId?: int }`
|
||||
- Returns: `204 void`
|
||||
#### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices`
|
||||
- Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }`
|
||||
#### Replace POS prices by SKU (net > gross) — `PUT /article/{sku}/prices`
|
||||
- Params: `sku: str, body: { prices: { net?: num, gross?: num, taxRate?: num, minmultiplier?: num }[] }`
|
||||
- Returns: `204 void`
|
||||
#### Print article label — `POST /article/{sku}/print`
|
||||
- Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }`
|
||||
- Params: `sku: str, body: { templateId: int, agentprinterId: int, quantity: int }`
|
||||
- Returns: `200 { success: bool }`
|
||||
#### List article properties — `GET /article/{sku}/property`
|
||||
- Params: `sku: str`
|
||||
@@ -163,10 +200,10 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### List article suppliers — `GET /article/{sku}/supplier`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { suppliers: T7[] }`
|
||||
- Returns: `200 { suppliers: T8[] }`
|
||||
#### Assign supplier to article — `POST /article/{sku}/supplier`
|
||||
- Params: `sku: str, body: { entityId: int, sku?: str|null, pu?: num, stock?: num|null, sort?: int|null, netPrice?: num|null, taxId?: int|null, taxRate?: num|null }`
|
||||
- Returns: `201 { supplier: T7 }`
|
||||
- Returns: `201 { supplier: T8 }`
|
||||
#### Reorder article suppliers — `PUT /article/{sku}/supplier/order`
|
||||
- Params: `sku: str, body: { ids: int[] }`
|
||||
- Returns: `200 { ids: int[] }`
|
||||
@@ -175,7 +212,7 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Update article supplier assignment — `PATCH /article/{sku}/supplier/{id}`
|
||||
- Params: `sku: str, id: int, body: { sku?: str|null, pu?: num, stock?: num|null, sort?: int, netPrice?: num|null, taxId?: int|null, taxRate?: num|null }`
|
||||
- Returns: `200 { supplier: T7 }`
|
||||
- Returns: `200 { supplier: T8 }`
|
||||
#### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock`
|
||||
- Params: `sku: str, body: { track_stock: bool }`
|
||||
- Returns: `204 void`
|
||||
@@ -187,19 +224,19 @@ _none_
|
||||
|
||||
#### List attribute names — `GET /attributename`
|
||||
_none_
|
||||
- Returns: `200 { attributenames: T15[] }`
|
||||
- Returns: `200 { attributenames: T17[] }`
|
||||
#### Create attribute name — `POST /attributename`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { attributename: T15 }`
|
||||
- Returns: `201 { attributename: T17 }`
|
||||
#### Reorder attribute names — `PUT /attributename/order`
|
||||
- Params: `body: { attributenameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### List values for an attribute — `GET /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int`
|
||||
- Returns: `200 { values: T27[] }`
|
||||
- Returns: `200 { values: T30[] }`
|
||||
#### Create value for an attribute — `POST /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int, body: { value: str, sort?: int }`
|
||||
- Returns: `201 { attributevalue: T27 }`
|
||||
- Returns: `201 { attributevalue: T30 }`
|
||||
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
||||
- Params: `attributeId: int, body: { attributevalueIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -208,7 +245,7 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute name — `PATCH /attributename/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { attributename: T15 }`
|
||||
- Returns: `200 { attributename: T17 }`
|
||||
|
||||
### Section: /attributevalue
|
||||
|
||||
@@ -217,28 +254,40 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute value — `PATCH /attributevalue/{id}`
|
||||
- Params: `id: int, body: { value?: str, sort?: int }`
|
||||
- Returns: `200 { attributevalue: T27 }`
|
||||
- Returns: `200 { attributevalue: T30 }`
|
||||
#### Delete attribute value image — `DELETE /attributevalue/{id}/image`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T33[] } }`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T37[] } }`
|
||||
#### Add or replace attribute value image — `POST /attributevalue/{id}/image`
|
||||
- Params: `id: int, image/avif`
|
||||
- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T33[] } }`
|
||||
- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T37[] } }`
|
||||
|
||||
### Section: /auth
|
||||
|
||||
#### Login with Google ID token — `POST /auth/login`
|
||||
- Params: `body: { idToken: str }`
|
||||
- Returns: `200 { message: str, user: T32 }`
|
||||
- Returns: `200 { message: str, user: T36 }`
|
||||
#### Logout — `POST /auth/logout`
|
||||
_none_
|
||||
- Returns: `200 { message: str }`
|
||||
#### Current user — `GET /auth/me`
|
||||
_none_
|
||||
- Returns: `200 { user: T32, googleClientId: str }`
|
||||
- Returns: `200 { user: T36, googleClientId: str, schemaVersion: int, vhost: bool, vhostSettings: str }`
|
||||
#### Set selected company — `PUT /auth/selected-company`
|
||||
- Params: `body: { companyId: int }`
|
||||
- Returns: `200 { user: T32 }`
|
||||
- Returns: `200 { user: T36 }`
|
||||
|
||||
### Section: /autoinvite
|
||||
|
||||
#### List auto-invitations — `GET /autoinvite`
|
||||
_none_
|
||||
- Returns: `200 { autoinvites: { id: int, email: str, role: str, createdAt: str }[] }`
|
||||
#### Create auto-invitation — `POST /autoinvite`
|
||||
- Params: `body: { email: str, role?: str }`
|
||||
- Returns: `201 { autoinvite: { id: int, email: str, role: str } }`
|
||||
#### Delete auto-invitation — `DELETE /autoinvite/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
|
||||
### Section: /backup
|
||||
|
||||
@@ -259,7 +308,7 @@ _none_
|
||||
- Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }`
|
||||
#### Create brand — `POST /brand`
|
||||
- Params: `body: { name: str, gsprpinfo?: str }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T33[], gsprpinfo?: str|null } }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T37[], gsprpinfo?: str|null } }`
|
||||
#### Delete brand — `DELETE /brand/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
@@ -268,19 +317,19 @@ _none_
|
||||
- Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }`
|
||||
#### Delete brand image — `DELETE /brand/{id}/image`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T33[] } }`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T37[] } }`
|
||||
#### Add or replace brand image — `POST /brand/{id}/image`
|
||||
- Params: `id: int, image/avif`
|
||||
- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T33[] } }`
|
||||
- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T37[] } }`
|
||||
|
||||
### Section: /carrier
|
||||
|
||||
#### List carriers — `GET /carrier`
|
||||
_none_
|
||||
- Returns: `200 { carriers: T30[] }`
|
||||
- Returns: `200 { carriers: T34[] }`
|
||||
#### Create carrier — `POST /carrier`
|
||||
- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `201 { carrier: T30 }`
|
||||
- Returns: `201 { carrier: T34 }`
|
||||
#### Reorder carriers — `PUT /carrier/order`
|
||||
- Params: `body: { carrierIds: int[] }`
|
||||
- Returns: `200 { carrierIds: int[] }`
|
||||
@@ -289,10 +338,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Get carrier by ID — `GET /carrier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { carrier: T30 }`
|
||||
- Returns: `200 { carrier: T34 }`
|
||||
#### Update carrier — `PATCH /carrier/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `200 { carrier: T30 }`
|
||||
- Returns: `200 { carrier: T34 }`
|
||||
|
||||
### Section: /category
|
||||
|
||||
@@ -315,8 +364,8 @@ _none_
|
||||
- Params: `id: int, body: { name?: str, parentId?: int }`
|
||||
- Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }`
|
||||
#### Articles in category — `GET /category/{id}/articles`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T25|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }`
|
||||
- Params: `id: int, query: includeChildren?: bool`
|
||||
- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T28|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }`
|
||||
#### List category attribute values — `GET /category/{id}/attributevalue`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }`
|
||||
@@ -346,10 +395,10 @@ _none_
|
||||
|
||||
#### List companies — `GET /company`
|
||||
_none_
|
||||
- Returns: `200 { companies: T17[] }`
|
||||
- Returns: `200 { companies: T19[] }`
|
||||
#### Create company — `POST /company`
|
||||
- Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `201 { company: T17, user: T32 }`
|
||||
- Returns: `201 { company: T19, user: T36 }`
|
||||
#### Export company catalog as zip archive (SSE) — `GET /company/export`
|
||||
- Params: `query: stream?: str`
|
||||
- Returns: `200 SSE`
|
||||
@@ -379,7 +428,22 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Update company — `PUT /company/{id}`
|
||||
- Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `200 { company: T17 }`
|
||||
- Returns: `200 { company: T19 }`
|
||||
|
||||
### Section: /companyuser
|
||||
|
||||
#### List company users — `GET /companyuser`
|
||||
_none_
|
||||
- Returns: `200 { companyusers: T31[] }`
|
||||
#### Add an existing user to the company — `POST /companyuser`
|
||||
- Params: `body: { email: str, role?: str }`
|
||||
- Returns: `201 { companyuser: T31 }`
|
||||
#### Remove a user from the company — `DELETE /companyuser/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Change a company user's role — `PATCH /companyuser/{id}`
|
||||
- Params: `id: int, body: { role: str }`
|
||||
- Returns: `200 { companyuser: T31 }`
|
||||
|
||||
### Section: /customergroup
|
||||
|
||||
@@ -403,7 +467,7 @@ _none_
|
||||
|
||||
#### List deliveries — `GET /delivery`
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int`
|
||||
- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T36 }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T40 }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create delivery — `POST /delivery`
|
||||
- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }`
|
||||
- Returns: `201 { delivery: T4 }`
|
||||
@@ -424,52 +488,52 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T9, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
|
||||
### Section: /entity
|
||||
|
||||
#### List entities — `GET /entity`
|
||||
- Params: `query: customergroupId?: int, role?: str`
|
||||
- Returns: `200 { entities: T24[] }`
|
||||
- Returns: `200 { entities: T27[] }`
|
||||
#### Create entity — `POST /entity`
|
||||
- Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }`
|
||||
- Returns: `201 { entity: T24 }`
|
||||
- Returns: `201 { entity: T27 }`
|
||||
#### Peek next customer number — `GET /entity/next-number`
|
||||
_none_
|
||||
- Returns: `200 { number: str }`
|
||||
#### List entity addresses — `GET /entity/{entityId}/address`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { addresses: T12[] }`
|
||||
- Returns: `200 { addresses: T14[] }`
|
||||
#### Create entity address — `POST /entity/{entityId}/address`
|
||||
- Params: `entityId: int, body: { addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }`
|
||||
- Returns: `201 { address: T12 }`
|
||||
- Returns: `201 { address: T14 }`
|
||||
#### Delete entity address — `DELETE /entity/{entityId}/address/{id}`
|
||||
- Params: `entityId: int, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update entity address — `PATCH /entity/{entityId}/address/{id}`
|
||||
- Params: `entityId: int, id: int, body: { addressType?: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }`
|
||||
- Returns: `200 { address: T12 }`
|
||||
- Returns: `200 { address: T14 }`
|
||||
#### List entity contacts — `GET /entity/{entityId}/contact`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { contacts: T34[] }`
|
||||
- Returns: `200 { contacts: T38[] }`
|
||||
#### Create entity contact — `POST /entity/{entityId}/contact`
|
||||
- Params: `entityId: int, body: { contactType: str, contact: str }`
|
||||
- Returns: `201 { contact: T34 }`
|
||||
- Returns: `201 { contact: T38 }`
|
||||
#### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: int, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update entity contact — `PATCH /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }`
|
||||
- Returns: `200 { contact: T34 }`
|
||||
- Returns: `200 { contact: T38 }`
|
||||
#### Delete entity — `DELETE /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get entity — `GET /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { entity: T24 }`
|
||||
- Returns: `200 { entity: T27 }`
|
||||
#### Update entity — `PATCH /entity/{id}`
|
||||
- Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
|
||||
- Returns: `200 { entity: T24 }`
|
||||
- Returns: `200 { entity: T27 }`
|
||||
|
||||
### Section: /events
|
||||
|
||||
@@ -478,6 +542,7 @@ _none_
|
||||
- Returns: `200 SSE`
|
||||
|
||||
- Events:
|
||||
- `user`: `{ selectedCompanyId }`
|
||||
- `company`: `{ companyId }`
|
||||
- `category`: `{}`
|
||||
- `articles`: `{}`
|
||||
@@ -486,9 +551,15 @@ _none_
|
||||
- `ledger`: `{}`
|
||||
- `attributename`: `{}`
|
||||
- `propertyname`: `{}`
|
||||
- `companyuser`: `{}`
|
||||
- `autoinvite`: `{}`
|
||||
- `labeltemplate`: `{}`
|
||||
- `printer`: `{}`
|
||||
- `printeragent`: `{}`
|
||||
- `agentprinter`: `{ printers } or {}`
|
||||
- `printerjob`: `{ job } or { jobId, state }`
|
||||
- `warehouse`: `{}`
|
||||
- `supplier`: `{}`
|
||||
- `vfs`: `{}`
|
||||
- `modelconversation`: `{}`
|
||||
- `modelconversation-<id>`: `{}`
|
||||
@@ -515,35 +586,38 @@ _none_
|
||||
_none_
|
||||
- Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }`
|
||||
#### Create label template — `POST /labeltemplate`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T22[] } }`
|
||||
- Returns: `201 { labeltemplate: T8 }`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T25[] } }`
|
||||
- Returns: `201 { labeltemplate: T9 }`
|
||||
#### Test print label template — `POST /labeltemplate/testprint`
|
||||
- Params: `body: { agentprinterId: int, templateId?: int, objects?: any[], width?: int, height?: int, dpi?: int, sku?: str, quantity?: int }`
|
||||
- Returns: `200 { success: bool }`
|
||||
#### Delete label template — `DELETE /labeltemplate/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get label template by ID — `GET /labeltemplate/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { labeltemplate: T8 }`
|
||||
- Returns: `200 { labeltemplate: T9 }`
|
||||
#### Update label template (partial) — `PATCH /labeltemplate/{id}`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T22[] } }`
|
||||
- Returns: `200 { labeltemplate: T8 }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T25[] } }`
|
||||
- Returns: `200 { labeltemplate: T9 }`
|
||||
#### Update label template — `PUT /labeltemplate/{id}`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T22[] } }`
|
||||
- Returns: `200 { labeltemplate: T8 }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T25[] } }`
|
||||
- Returns: `200 { labeltemplate: T9 }`
|
||||
|
||||
### Section: /ledger
|
||||
|
||||
#### Query ledger by manifest article ID or SKU — `GET /ledger`
|
||||
- Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str`
|
||||
- Returns: `200 { ledger: T14[] }`
|
||||
- Returns: `200 { ledger: T16[] }`
|
||||
#### Query company-wide ledger history — `GET /ledger/history`
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int`
|
||||
- Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}`
|
||||
- Params: `manifestarticleId: int, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T14[] }`
|
||||
- Returns: `200 { ledger: T16[] }`
|
||||
#### Query ledger by article SKU — `GET /ledger/sku/{sku}`
|
||||
- Params: `sku: str, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T14[] }`
|
||||
- Returns: `200 { ledger: T16[] }`
|
||||
|
||||
### Section: /mcp
|
||||
|
||||
@@ -573,16 +647,16 @@ _none_
|
||||
|
||||
#### List conversations — `GET /modelconversation`
|
||||
_none_
|
||||
- Returns: `200 { conversations: T16[] }`
|
||||
- Returns: `200 { conversations: T18[] }`
|
||||
#### Create conversation — `POST /modelconversation`
|
||||
- Params: `body: { provider: str, model: str }`
|
||||
- Returns: `201 { conversation: T16 }`
|
||||
- Returns: `201 { conversation: T18 }`
|
||||
#### Delete conversation — `DELETE /modelconversation/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get conversation — `GET /modelconversation/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { conversation: T16 }`
|
||||
- Returns: `200 { conversation: T18 }`
|
||||
#### List conversation messages — `GET /modelconversation/{id}/message`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { messages: { id: int, conversation_id: int, created_at: str, role: str, message: str }[] }`
|
||||
@@ -623,7 +697,7 @@ _none_
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int`
|
||||
- Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create order — `POST /order`
|
||||
- Params: `body: { number: str, date: str, entityId: int, lines: T19[], externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, entityId: int, lines: T21[], externalNumber?: str|null }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Delete order — `DELETE /order/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -632,7 +706,7 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { order: T1 }`
|
||||
#### Update order — `PATCH /order/{id}`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }`
|
||||
- Returns: `200 { order: T1 }`
|
||||
#### Delete order file attachment — `DELETE /order/{id}/file/{fileId}`
|
||||
- Params: `id: int, fileId: int`
|
||||
@@ -642,13 +716,13 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### List payments of an order — `GET /order/{id}/payment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { payments: T29[] }`
|
||||
- Returns: `200 { payments: T33[] }`
|
||||
#### Add payment to an order — `POST /order/{id}/payment`
|
||||
- Params: `id: int, body: { accountId: int, type: str, amount: num }`
|
||||
- Returns: `201 { payment: T29 }`
|
||||
- Returns: `201 { payment: T33 }`
|
||||
#### Generate and attach order PDF — `POST /order/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T9, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
#### List shipments of an order — `GET /order/{id}/shipment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shipments: T2[] }`
|
||||
@@ -657,10 +731,10 @@ _none_
|
||||
- Returns: `201 { shipment: T2 }`
|
||||
#### List shippings of an order — `GET /order/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T20[] }`
|
||||
- Returns: `200 { shippings: T23[] }`
|
||||
#### Create shipping for an order — `POST /order/{id}/shipping`
|
||||
- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }`
|
||||
- Returns: `201 { shipping: T20 }`
|
||||
- Returns: `201 { shipping: T23 }`
|
||||
|
||||
### Section: /package
|
||||
|
||||
@@ -678,16 +752,16 @@ _none_
|
||||
|
||||
#### List POS terminals — `GET /posterminal`
|
||||
_none_
|
||||
- Returns: `200 { posterminals: T10[] }`
|
||||
- Returns: `200 { posterminals: T7[] }`
|
||||
#### Create POS terminal — `PUT /posterminal`
|
||||
- Params: `body: { name: str, rootCategoryId?: int|null, syncRootArticles?: bool }`
|
||||
- Returns: `200 { posterminal: T10 }`
|
||||
- Params: `body: { name: str, rootCategoryId?: int|null, syncRootArticles?: bool, sort?: int, enabled?: bool }`
|
||||
- Returns: `200 { posterminal: T7 }`
|
||||
#### Delete POS terminal — `DELETE /posterminal/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update POS terminal — `PATCH /posterminal/{id}`
|
||||
- Params: `id: int, body: { name?: str, rootCategoryId?: int|null, syncRootArticles?: bool, pairingpin?: str|null }`
|
||||
- Returns: `200 { posterminal: T10 }`
|
||||
- Params: `id: int, body: { name?: str, rootCategoryId?: int|null, syncRootArticles?: bool, sort?: int, enabled?: bool, pairingpin?: str|null }`
|
||||
- Returns: `200 { posterminal: T7 }`
|
||||
#### Disable all categories on terminal — `DELETE /posterminal/{id}/all`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { id: int, categoryIds: int[] }`
|
||||
@@ -705,34 +779,76 @@ _none_
|
||||
|
||||
#### List printers — `GET /printer`
|
||||
_none_
|
||||
- Returns: `200 { printers: T23[] }`
|
||||
- Returns: `200 { printers: T26[] }`
|
||||
#### Create printer — `POST /printer`
|
||||
- Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `201 { printer: T23 }`
|
||||
- Returns: `201 { printer: T26 }`
|
||||
#### Reorder printers — `PUT /printer/order`
|
||||
- Params: `body: { printerIds: int[] }`
|
||||
- Returns: `200 { printerIds: int[] }`
|
||||
#### Get live printer states — `GET /printer/state`
|
||||
- Params: `query: serial?: str, agentId?: int`
|
||||
- Returns: `200 { printers: {}[] }`
|
||||
#### Delete printer — `DELETE /printer/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get printer by ID — `GET /printer/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { printer: T23 }`
|
||||
- Returns: `200 { printer: T26 }`
|
||||
#### Update printer (partial) — `PATCH /printer/{id}`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `200 { printer: T23 }`
|
||||
- Returns: `200 { printer: T26 }`
|
||||
#### Update printer — `PUT /printer/{id}`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `200 { printer: T23 }`
|
||||
- Returns: `200 { printer: T26 }`
|
||||
#### Get live state for a printer — `GET /printer/{id}/state`
|
||||
- Params: `id: str`
|
||||
- Returns: `200 { printer: {} }`
|
||||
|
||||
### Section: /printeragent
|
||||
|
||||
#### List printer agents — `GET /printeragent`
|
||||
_none_
|
||||
- Returns: `200 { printeragents: T12[] }`
|
||||
#### Create printer agent — `PUT /printeragent`
|
||||
- Params: `body: { name: str, sort?: int, enabled?: bool }`
|
||||
- Returns: `200 { printeragent: T12 }`
|
||||
#### Delete printer agent — `DELETE /printeragent/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update printer agent — `PATCH /printeragent/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, enabled?: bool }`
|
||||
- Returns: `200 { printeragent: T12 }`
|
||||
|
||||
### Section: /printerjob
|
||||
|
||||
#### List printer jobs — `GET /printerjob`
|
||||
- Params: `query: agentprinterId?: int, state?: str`
|
||||
- Returns: `200 { printerjobs: T22[] }`
|
||||
#### Create print job — `POST /printerjob`
|
||||
- Params: `body: { agentprinterId: int, data: str, type?: str }`
|
||||
- Returns: `201 { printerjob: T22 }`
|
||||
#### Cancel all pending and processing printer jobs — `POST /printerjob/cancel-all`
|
||||
- Params: `body?: { agentprinterId?: int }`
|
||||
- Returns: `200 { success: bool, cancelledCount: int, jobs: T22[] }`
|
||||
#### Cancel and delete printer job — `DELETE /printerjob/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { success: bool, deletedJob: T22 }`
|
||||
#### Get printer job — `GET /printerjob/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { printerjob: T22 }`
|
||||
#### Cancel printer job — `POST /printerjob/{id}/cancel`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { success: bool, printerjob: T22 }`
|
||||
|
||||
### Section: /propertyname
|
||||
|
||||
#### List property names — `GET /propertyname`
|
||||
_none_
|
||||
- Returns: `200 { propertynames: T28[] }`
|
||||
- Returns: `200 { propertynames: T32[] }`
|
||||
#### Create property name — `POST /propertyname`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { propertyname: T28 }`
|
||||
- Returns: `201 { propertyname: T32 }`
|
||||
#### Reorder property names — `PUT /propertyname/order`
|
||||
- Params: `body: { propertynameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -741,7 +857,7 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update property name — `PATCH /propertyname/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { propertyname: T28 }`
|
||||
- Returns: `200 { propertyname: T32 }`
|
||||
|
||||
### Section: /public
|
||||
|
||||
@@ -753,7 +869,7 @@ _none_
|
||||
- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, net: num|null, taxRate: num|null, gross: num|null, trackStock: bool, brand: { id: int|null, name: str }, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }`
|
||||
#### Get public article detail — `GET /public/{companyId}/articles/{sku}`
|
||||
- Params: `companyId: int, sku: str`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T26|null, brand: T25|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T29|null, brand: T28|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }`
|
||||
#### List public categories — `GET /public/{companyId}/categories`
|
||||
- Params: `companyId: int`
|
||||
- Returns: `200 { categories: { id: int, parentId: int|null, sort: int, name: str, slug: str, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }`
|
||||
@@ -764,7 +880,7 @@ _none_
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int`
|
||||
- Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create quote — `POST /quote`
|
||||
- Params: `body: { number: str, date: str, lines: T19[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, lines: T21[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Returns: `201 { quote: T3 }`
|
||||
#### Delete quote — `DELETE /quote/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -773,7 +889,7 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { quote: T3 }`
|
||||
#### Update quote — `PATCH /quote/{id}`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }`
|
||||
- Returns: `200 { quote: T3 }`
|
||||
#### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}`
|
||||
- Params: `id: int, fileId: int`
|
||||
@@ -782,11 +898,11 @@ _none_
|
||||
- Params: `id: int, fileId: int, query: download?: bool`
|
||||
- Returns: `200 str`
|
||||
#### Create order from quote — `POST /quote/{id}/order`
|
||||
- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }`
|
||||
- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T21[] }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Generate and attach quote PDF — `POST /quote/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T9, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
|
||||
### Section: /retoure
|
||||
|
||||
@@ -873,13 +989,13 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T9, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
#### List packages of a shipment — `GET /shipment/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T20[] }`
|
||||
- Returns: `200 { shippings: T23[] }`
|
||||
#### Create package for a shipment — `POST /shipment/{id}/shipping`
|
||||
- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }`
|
||||
- Returns: `201 { shipping: T20 }`
|
||||
- Returns: `201 { shipping: T23 }`
|
||||
|
||||
### Section: /shipping
|
||||
|
||||
@@ -888,7 +1004,7 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Update shipping — `PATCH /shipping/{id}`
|
||||
- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }`
|
||||
- Returns: `200 { shipping: T20 }`
|
||||
- Returns: `200 { shipping: T23 }`
|
||||
#### List packages of a shipping — `GET /shipping/{id}/package`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }`
|
||||
@@ -909,7 +1025,7 @@ _none_
|
||||
- Returns: `200`
|
||||
#### Adjust stock manually — `POST /stock/adjust`
|
||||
- Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }`
|
||||
- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T14[] }`
|
||||
- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T16[] }`
|
||||
#### Ship shipment manifest item(s) — `POST /stock/ship`
|
||||
- Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }`
|
||||
- Returns: `200`
|
||||
@@ -918,40 +1034,40 @@ _none_
|
||||
|
||||
#### List subagent schedules — `GET /subagentschedule`
|
||||
_none_
|
||||
- Returns: `200 { schedules: T13[] }`
|
||||
- Returns: `200 { schedules: T15[] }`
|
||||
#### Create subagent schedule — `POST /subagentschedule`
|
||||
- Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }`
|
||||
- Returns: `201 { schedule: T13 }`
|
||||
- Returns: `201 { schedule: T15 }`
|
||||
#### Delete subagent schedule — `DELETE /subagentschedule/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get subagent schedule by ID — `GET /subagentschedule/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { schedule: T13 }`
|
||||
- Returns: `200 { schedule: T15 }`
|
||||
#### Update subagent schedule — `PUT /subagentschedule/{id}`
|
||||
- Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }`
|
||||
- Returns: `200 { schedule: T13 }`
|
||||
- Returns: `200 { schedule: T15 }`
|
||||
|
||||
### Section: /supplier
|
||||
|
||||
#### List suppliers — `GET /supplier`
|
||||
_none_
|
||||
- Returns: `200 { suppliers: T35[] }`
|
||||
- Returns: `200 { suppliers: T39[] }`
|
||||
#### Create supplier — `POST /supplier`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { supplier: T35 }`
|
||||
- Returns: `201 { supplier: T39 }`
|
||||
#### Delete supplier — `DELETE /supplier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update supplier — `PATCH /supplier/{id}`
|
||||
- Params: `id: int, body: { name: str }`
|
||||
- Returns: `200 { supplier: T35 }`
|
||||
- Returns: `200 { supplier: T39 }`
|
||||
#### List supplier articles by SKUs — `GET /supplier/{id}/articles`
|
||||
- Params: `id: int, query: skus?: str`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T38|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T42|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
#### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles`
|
||||
- Params: `id: int, body?: { skus?: str[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T38|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T42|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
|
||||
### Section: /thumb
|
||||
|
||||
@@ -966,10 +1082,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### List units — `GET /unit`
|
||||
_none_
|
||||
- Returns: `200 { units: T26[] }`
|
||||
- Returns: `200 { units: T29[] }`
|
||||
#### Upsert unit — `PUT /unit`
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: T26 }`
|
||||
- Returns: `200 { unit: T29 }`
|
||||
|
||||
### Section: /v1
|
||||
|
||||
@@ -980,7 +1096,7 @@ _none_
|
||||
- Params: `query: path: str, size?: int, w?: int, h?: int, format?: str`
|
||||
- Returns: `200 jpeg`
|
||||
#### POS discovery and pairing — `GET /v1/client`
|
||||
- Params: `query: authCode: str, name?: str`
|
||||
- Params: `query: authCode: str, name?: str, clientversion?: str`
|
||||
- Returns: `200 { authCode: str|null, authToken: str|null, certificateFingerprint: str, certificateSerialNumber: str, mandantId: str, mandantName: str|null, mandantDatabase: str|null, serverFingerprint: str|null, name: str|null, serverTimestamp: str }`
|
||||
#### JTL-POS customer catalog synchronization — `GET /v1/customer`
|
||||
- Params: `query: lastChangedCustomer?: str, limit?: int`
|
||||
@@ -1060,3 +1176,9 @@ _none_
|
||||
#### Update warehouse — `PUT /warehouse/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int }`
|
||||
- Returns: `200 { warehouse: { id: int, name: str, sort: int } }`
|
||||
|
||||
### Section: /zpljob
|
||||
|
||||
#### Create ZPL print job — `POST /zpljob`
|
||||
- Params: `body: { agentprinterId: int, data: str, copiescount?: int }`
|
||||
- Returns: `201 { printerjob: T22 }`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview
|
||||
|
||||
Overview of all 204 API endpoints across all modules.
|
||||
Overview of all 196 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -9,34 +9,33 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
|
||||
### Reusable types
|
||||
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T12[], externalNumber?: str|null, createdAt?: str, shipping?: T14|null, shippings?: T14[], payment?: T22|null, payments?: T22[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T12[], shippings: T14[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T12[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T15[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T27 }`
|
||||
- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T28|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T16[] }, thumb?: str|null }`
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T11[], externalNumber?: str|null, createdAt?: str, shipping?: T13|null, shippings?: T13[], payment?: T21|null, payments?: T21[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T11[], shippings: T13[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T11[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T14[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T26 }`
|
||||
- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T27|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T15[] }, thumb?: str|null }`
|
||||
- `T7` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }`
|
||||
- `T8` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }`
|
||||
- `T9` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }`
|
||||
- `T10` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }`
|
||||
- `T11` = `{ id: int, name: str, sort: int, exclusive: bool, values: T20[], articleCount?: int }`
|
||||
- `T12` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T13` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T14` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T15` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T16` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T17` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T18` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T19` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T20` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T21` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T22` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T23` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T24` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T25` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T26` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T27` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T28` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
- `T9` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }`
|
||||
- `T10` = `{ id: int, name: str, sort: int, exclusive: bool, values: T18[], articleCount?: int }`
|
||||
- `T11` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T12` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T13` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T15` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T16` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T17` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T18` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T19` = `{ id: int, googleAuthId: int, email: str, role: str, picture?: str|null }`
|
||||
- `T20` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T21` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T22` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T23` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T24` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T25` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T26` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T27` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
|
||||
### Routes
|
||||
|
||||
@@ -54,7 +53,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
- Returns: `204 void`
|
||||
#### Get article by SKU — `GET /article/{sku}`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T19, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }`
|
||||
- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T17, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }`
|
||||
#### Update article by SKU — `PATCH /article/{sku}`
|
||||
- Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }`
|
||||
- Returns: `204 void`
|
||||
@@ -109,11 +108,11 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
#### Toggle parent mode for an article — `POST /article/{sku}/parent`
|
||||
- Params: `sku: str, body: { isParent: bool, attributeNameId?: int }`
|
||||
- Returns: `204 void`
|
||||
#### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices`
|
||||
- Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }`
|
||||
#### Replace POS prices by SKU (net > gross) — `PUT /article/{sku}/prices`
|
||||
- Params: `sku: str, body: { prices: { net?: num, gross?: num, taxRate?: num, minmultiplier?: num }[] }`
|
||||
- Returns: `204 void`
|
||||
#### Print article label — `POST /article/{sku}/print`
|
||||
- Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }`
|
||||
- Params: `sku: str, body: { templateId: int, agentprinterId: int, quantity: int }`
|
||||
- Returns: `200 { success: bool }`
|
||||
#### List article properties — `GET /article/{sku}/property`
|
||||
- Params: `sku: str`
|
||||
@@ -150,19 +149,19 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
|
||||
#### List attribute names — `GET /attributename`
|
||||
_none_
|
||||
- Returns: `200 { attributenames: T11[] }`
|
||||
- Returns: `200 { attributenames: T10[] }`
|
||||
#### Create attribute name — `POST /attributename`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { attributename: T11 }`
|
||||
- Returns: `201 { attributename: T10 }`
|
||||
#### Reorder attribute names — `PUT /attributename/order`
|
||||
- Params: `body: { attributenameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### List values for an attribute — `GET /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int`
|
||||
- Returns: `200 { values: T20[] }`
|
||||
- Returns: `200 { values: T18[] }`
|
||||
#### Create value for an attribute — `POST /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int, body: { value: str, sort?: int }`
|
||||
- Returns: `201 { attributevalue: T20 }`
|
||||
- Returns: `201 { attributevalue: T18 }`
|
||||
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
||||
- Params: `attributeId: int, body: { attributevalueIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -171,7 +170,7 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute name — `PATCH /attributename/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { attributename: T11 }`
|
||||
- Returns: `200 { attributename: T10 }`
|
||||
|
||||
### Section: /attributevalue
|
||||
|
||||
@@ -180,10 +179,22 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute value — `PATCH /attributevalue/{id}`
|
||||
- Params: `id: int, body: { value?: str, sort?: int }`
|
||||
- Returns: `200 { attributevalue: T20 }`
|
||||
- Returns: `200 { attributevalue: T18 }`
|
||||
#### Delete attribute value image — `DELETE /attributevalue/{id}/image`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T24[] } }`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T23[] } }`
|
||||
|
||||
### Section: /autoinvite
|
||||
|
||||
#### List auto-invitations — `GET /autoinvite`
|
||||
_none_
|
||||
- Returns: `200 { autoinvites: { id: int, email: str, role: str, createdAt: str }[] }`
|
||||
#### Create auto-invitation — `POST /autoinvite`
|
||||
- Params: `body: { email: str, role?: str }`
|
||||
- Returns: `201 { autoinvite: { id: int, email: str, role: str } }`
|
||||
#### Delete auto-invitation — `DELETE /autoinvite/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
|
||||
### Section: /brand
|
||||
|
||||
@@ -192,7 +203,7 @@ _none_
|
||||
- Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }`
|
||||
#### Create brand — `POST /brand`
|
||||
- Params: `body: { name: str, gsprpinfo?: str }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T24[], gsprpinfo?: str|null } }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T23[], gsprpinfo?: str|null } }`
|
||||
#### Delete brand — `DELETE /brand/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
@@ -201,16 +212,16 @@ _none_
|
||||
- Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }`
|
||||
#### Delete brand image — `DELETE /brand/{id}/image`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T24[] } }`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T23[] } }`
|
||||
|
||||
### Section: /carrier
|
||||
|
||||
#### List carriers — `GET /carrier`
|
||||
_none_
|
||||
- Returns: `200 { carriers: T23[] }`
|
||||
- Returns: `200 { carriers: T22[] }`
|
||||
#### Create carrier — `POST /carrier`
|
||||
- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `201 { carrier: T23 }`
|
||||
- Returns: `201 { carrier: T22 }`
|
||||
#### Reorder carriers — `PUT /carrier/order`
|
||||
- Params: `body: { carrierIds: int[] }`
|
||||
- Returns: `200 { carrierIds: int[] }`
|
||||
@@ -219,10 +230,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Get carrier by ID — `GET /carrier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { carrier: T23 }`
|
||||
- Returns: `200 { carrier: T22 }`
|
||||
#### Update carrier — `PATCH /carrier/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `200 { carrier: T23 }`
|
||||
- Returns: `200 { carrier: T22 }`
|
||||
|
||||
### Section: /category
|
||||
|
||||
@@ -242,7 +253,7 @@ _none_
|
||||
- Params: `id: int, body: { name?: str, parentId?: int }`
|
||||
- Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }`
|
||||
#### Articles in category — `GET /category/{id}/articles`
|
||||
- Params: `id: int`
|
||||
- Params: `id: int, query: includeChildren?: bool`
|
||||
- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }`
|
||||
#### List category attribute values — `GET /category/{id}/attributevalue`
|
||||
- Params: `id: int`
|
||||
@@ -270,7 +281,7 @@ _none_
|
||||
|
||||
#### List companies — `GET /company`
|
||||
_none_
|
||||
- Returns: `200 { companies: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }[] }`
|
||||
- Returns: `200 { companies: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num, role: str }[] }`
|
||||
#### Get company history — `GET /company/history`
|
||||
- Params: `query: limit?: int`
|
||||
- Returns: `200 { history: { id: int, date: str, text: str, companyuserId?: int|null }[], truncated: bool }`
|
||||
@@ -291,7 +302,22 @@ _none_
|
||||
- Returns: `200 { setting: { key: str, value: str|null } }`
|
||||
#### Update company — `PUT /company/{id}`
|
||||
- Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `200 { company: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num } }`
|
||||
- Returns: `200 { company: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num, role: str } }`
|
||||
|
||||
### Section: /companyuser
|
||||
|
||||
#### List company users — `GET /companyuser`
|
||||
_none_
|
||||
- Returns: `200 { companyusers: T19[] }`
|
||||
#### Add an existing user to the company — `POST /companyuser`
|
||||
- Params: `body: { email: str, role?: str }`
|
||||
- Returns: `201 { companyuser: T19 }`
|
||||
#### Remove a user from the company — `DELETE /companyuser/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Change a company user's role — `PATCH /companyuser/{id}`
|
||||
- Params: `id: int, body: { role: str }`
|
||||
- Returns: `200 { companyuser: T19 }`
|
||||
|
||||
### Section: /customergroup
|
||||
|
||||
@@ -315,7 +341,7 @@ _none_
|
||||
|
||||
#### List deliveries — `GET /delivery`
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int`
|
||||
- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T27 }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T26 }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create delivery — `POST /delivery`
|
||||
- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }`
|
||||
- Returns: `201 { delivery: T4 }`
|
||||
@@ -339,10 +365,10 @@ _none_
|
||||
|
||||
#### List entities — `GET /entity`
|
||||
- Params: `query: customergroupId?: int, role?: str`
|
||||
- Returns: `200 { entities: T18[] }`
|
||||
- Returns: `200 { entities: T16[] }`
|
||||
#### Create entity — `POST /entity`
|
||||
- Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }`
|
||||
- Returns: `201 { entity: T18 }`
|
||||
- Returns: `201 { entity: T16 }`
|
||||
#### Peek next customer number — `GET /entity/next-number`
|
||||
_none_
|
||||
- Returns: `200 { number: str }`
|
||||
@@ -360,31 +386,25 @@ _none_
|
||||
- Returns: `200 { address: T8 }`
|
||||
#### List entity contacts — `GET /entity/{entityId}/contact`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { contacts: T25[] }`
|
||||
- Returns: `200 { contacts: T24[] }`
|
||||
#### Create entity contact — `POST /entity/{entityId}/contact`
|
||||
- Params: `entityId: int, body: { contactType: str, contact: str }`
|
||||
- Returns: `201 { contact: T25 }`
|
||||
- Returns: `201 { contact: T24 }`
|
||||
#### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: int, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update entity contact — `PATCH /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }`
|
||||
- Returns: `200 { contact: T25 }`
|
||||
- Returns: `200 { contact: T24 }`
|
||||
#### Delete entity — `DELETE /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get entity — `GET /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { entity: T18 }`
|
||||
- Returns: `200 { entity: T16 }`
|
||||
#### Update entity — `PATCH /entity/{id}`
|
||||
- Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
|
||||
- Returns: `200 { entity: T18 }`
|
||||
|
||||
### Section: /health
|
||||
|
||||
#### Health latency history — `GET /health/latency`
|
||||
- Params: `query: range?: str`
|
||||
- Returns: `200 { raw: { timestamp: int, value: num }[], avg: { timestamp: int, value: num }[], max: { timestamp: int, value: num }[] }`
|
||||
- Returns: `200 { entity: T16 }`
|
||||
|
||||
### Section: /labeltemplate
|
||||
|
||||
@@ -392,8 +412,11 @@ _none_
|
||||
_none_
|
||||
- Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }`
|
||||
#### Create label template — `POST /labeltemplate`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T16[] } }`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T15[] } }`
|
||||
- Returns: `201 { labeltemplate: T6 }`
|
||||
#### Test print label template — `POST /labeltemplate/testprint`
|
||||
- Params: `body: { agentprinterId: int, templateId?: int, objects?: any[], width?: int, height?: int, dpi?: int, sku?: str, quantity?: int }`
|
||||
- Returns: `200 { success: bool }`
|
||||
#### Delete label template — `DELETE /labeltemplate/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
@@ -401,26 +424,26 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { labeltemplate: T6 }`
|
||||
#### Update label template (partial) — `PATCH /labeltemplate/{id}`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T16[] } }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T15[] } }`
|
||||
- Returns: `200 { labeltemplate: T6 }`
|
||||
#### Update label template — `PUT /labeltemplate/{id}`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T16[] } }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T15[] } }`
|
||||
- Returns: `200 { labeltemplate: T6 }`
|
||||
|
||||
### Section: /ledger
|
||||
|
||||
#### Query ledger by manifest article ID or SKU — `GET /ledger`
|
||||
- Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str`
|
||||
- Returns: `200 { ledger: T10[] }`
|
||||
- Returns: `200 { ledger: T9[] }`
|
||||
#### Query company-wide ledger history — `GET /ledger/history`
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int`
|
||||
- Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}`
|
||||
- Params: `manifestarticleId: int, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T10[] }`
|
||||
- Returns: `200 { ledger: T9[] }`
|
||||
#### Query ledger by article SKU — `GET /ledger/sku/{sku}`
|
||||
- Params: `sku: str, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T10[] }`
|
||||
- Returns: `200 { ledger: T9[] }`
|
||||
|
||||
### Section: /number
|
||||
|
||||
@@ -437,7 +460,7 @@ _none_
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int`
|
||||
- Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create order — `POST /order`
|
||||
- Params: `body: { number: str, date: str, entityId: int, lines: T13[], externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, entityId: int, lines: T12[], externalNumber?: str|null }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Delete order — `DELETE /order/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -446,17 +469,17 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { order: T1 }`
|
||||
#### Update order — `PATCH /order/{id}`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T12[] }`
|
||||
- Returns: `200 { order: T1 }`
|
||||
#### Delete order file attachment — `DELETE /order/{id}/file/{fileId}`
|
||||
- Params: `id: int, fileId: int`
|
||||
- Returns: `204 void`
|
||||
#### List payments of an order — `GET /order/{id}/payment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { payments: T22[] }`
|
||||
- Returns: `200 { payments: T21[] }`
|
||||
#### Add payment to an order — `POST /order/{id}/payment`
|
||||
- Params: `id: int, body: { accountId: int, type: str, amount: num }`
|
||||
- Returns: `201 { payment: T22 }`
|
||||
- Returns: `201 { payment: T21 }`
|
||||
#### Generate and attach order PDF — `POST /order/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
@@ -468,10 +491,10 @@ _none_
|
||||
- Returns: `201 { shipment: T2 }`
|
||||
#### List shippings of an order — `GET /order/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T14[] }`
|
||||
- Returns: `200 { shippings: T13[] }`
|
||||
#### Create shipping for an order — `POST /order/{id}/shipping`
|
||||
- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }`
|
||||
- Returns: `201 { shipping: T14 }`
|
||||
- Returns: `201 { shipping: T13 }`
|
||||
|
||||
### Section: /package
|
||||
|
||||
@@ -485,38 +508,14 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
|
||||
### Section: /printer
|
||||
|
||||
#### List printers — `GET /printer`
|
||||
_none_
|
||||
- Returns: `200 { printers: T17[] }`
|
||||
#### Create printer — `POST /printer`
|
||||
- Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `201 { printer: T17 }`
|
||||
#### Reorder printers — `PUT /printer/order`
|
||||
- Params: `body: { printerIds: int[] }`
|
||||
- Returns: `200 { printerIds: int[] }`
|
||||
#### Delete printer — `DELETE /printer/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get printer by ID — `GET /printer/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { printer: T17 }`
|
||||
#### Update printer (partial) — `PATCH /printer/{id}`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `200 { printer: T17 }`
|
||||
#### Update printer — `PUT /printer/{id}`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `200 { printer: T17 }`
|
||||
|
||||
### Section: /propertyname
|
||||
|
||||
#### List property names — `GET /propertyname`
|
||||
_none_
|
||||
- Returns: `200 { propertynames: T21[] }`
|
||||
- Returns: `200 { propertynames: T20[] }`
|
||||
#### Create property name — `POST /propertyname`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { propertyname: T21 }`
|
||||
- Returns: `201 { propertyname: T20 }`
|
||||
#### Reorder property names — `PUT /propertyname/order`
|
||||
- Params: `body: { propertynameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -525,7 +524,7 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update property name — `PATCH /propertyname/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { propertyname: T21 }`
|
||||
- Returns: `200 { propertyname: T20 }`
|
||||
|
||||
### Section: /quote
|
||||
|
||||
@@ -533,7 +532,7 @@ _none_
|
||||
- Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int`
|
||||
- Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }`
|
||||
#### Create quote — `POST /quote`
|
||||
- Params: `body: { number: str, date: str, lines: T13[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, lines: T12[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Returns: `201 { quote: T3 }`
|
||||
#### Delete quote — `DELETE /quote/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -542,13 +541,13 @@ _none_
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { quote: T3 }`
|
||||
#### Update quote — `PATCH /quote/{id}`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T12[] }`
|
||||
- Returns: `200 { quote: T3 }`
|
||||
#### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}`
|
||||
- Params: `id: int, fileId: int`
|
||||
- Returns: `204 void`
|
||||
#### Create order from quote — `POST /quote/{id}/order`
|
||||
- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }`
|
||||
- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T12[] }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Generate and attach quote PDF — `POST /quote/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
@@ -624,10 +623,10 @@ _none_
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
#### List packages of a shipment — `GET /shipment/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T14[] }`
|
||||
- Returns: `200 { shippings: T13[] }`
|
||||
#### Create package for a shipment — `POST /shipment/{id}/shipping`
|
||||
- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }`
|
||||
- Returns: `201 { shipping: T14 }`
|
||||
- Returns: `201 { shipping: T13 }`
|
||||
|
||||
### Section: /shipping
|
||||
|
||||
@@ -636,7 +635,7 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Update shipping — `PATCH /shipping/{id}`
|
||||
- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }`
|
||||
- Returns: `200 { shipping: T14 }`
|
||||
- Returns: `200 { shipping: T13 }`
|
||||
#### List packages of a shipping — `GET /shipping/{id}/package`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }`
|
||||
@@ -644,12 +643,6 @@ _none_
|
||||
- Params: `id: int, body: { entityaddressId: int, type: str, state: str, details?: str }`
|
||||
- Returns: `201 { package: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null } }`
|
||||
|
||||
### Section: /smallthumb
|
||||
|
||||
#### Small thumb image by hash — `GET /smallthumb/{fullHash}`
|
||||
- Params: `fullHash: str`
|
||||
- Returns: `200 avif`
|
||||
|
||||
### Section: /stock
|
||||
|
||||
#### Accept delivery manifest item(s) — `POST /stock/accept`
|
||||
@@ -657,49 +650,31 @@ _none_
|
||||
- Returns: `200`
|
||||
#### Adjust stock manually — `POST /stock/adjust`
|
||||
- Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }`
|
||||
- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T10[] }`
|
||||
- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T9[] }`
|
||||
#### Ship shipment manifest item(s) — `POST /stock/ship`
|
||||
- Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }`
|
||||
- Returns: `200`
|
||||
|
||||
### Section: /subagentschedule
|
||||
|
||||
#### List subagent schedules — `GET /subagentschedule`
|
||||
_none_
|
||||
- Returns: `200 { schedules: T9[] }`
|
||||
#### Create subagent schedule — `POST /subagentschedule`
|
||||
- Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }`
|
||||
- Returns: `201 { schedule: T9 }`
|
||||
#### Delete subagent schedule — `DELETE /subagentschedule/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get subagent schedule by ID — `GET /subagentschedule/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { schedule: T9 }`
|
||||
#### Update subagent schedule — `PUT /subagentschedule/{id}`
|
||||
- Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }`
|
||||
- Returns: `200 { schedule: T9 }`
|
||||
|
||||
### Section: /supplier
|
||||
|
||||
#### List suppliers — `GET /supplier`
|
||||
_none_
|
||||
- Returns: `200 { suppliers: T26[] }`
|
||||
- Returns: `200 { suppliers: T25[] }`
|
||||
#### Create supplier — `POST /supplier`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { supplier: T26 }`
|
||||
- Returns: `201 { supplier: T25 }`
|
||||
#### Delete supplier — `DELETE /supplier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update supplier — `PATCH /supplier/{id}`
|
||||
- Params: `id: int, body: { name: str }`
|
||||
- Returns: `200 { supplier: T26 }`
|
||||
- Returns: `200 { supplier: T25 }`
|
||||
#### List supplier articles by SKUs — `GET /supplier/{id}/articles`
|
||||
- Params: `id: int, query: skus?: str`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T28|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T27|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
#### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles`
|
||||
- Params: `id: int, body?: { skus?: str[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T28|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T27|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
|
||||
### Section: /unit
|
||||
|
||||
@@ -708,19 +683,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### List units — `GET /unit`
|
||||
_none_
|
||||
- Returns: `200 { units: T19[] }`
|
||||
- Returns: `200 { units: T17[] }`
|
||||
#### Upsert unit — `PUT /unit`
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: T19 }`
|
||||
|
||||
### Section: /v1
|
||||
|
||||
#### JTL-POS deleted entity synchronization — `GET /v1/deletedentity`
|
||||
- Params: `query: lastChangedDeletedEntity?: str, limit?: int`
|
||||
- Returns: `200 { entityId: str, entityType: int, lastChanged: int }[]`
|
||||
#### JTL-POS order upload — `POST /v1/order`
|
||||
- Params: `query: mandantId?: str, body: { orders?: {}[] }`
|
||||
- Returns: `200 { status: str, externalOrderId: str, message: str }[]`
|
||||
- Returns: `200 { unit: T17 }`
|
||||
|
||||
### Section: /warehouse
|
||||
|
||||
|
||||
30
docs/api/routes/agent/events.md
Normal file
30
docs/api/routes/agent/events.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# `GET /agent/events`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Printer agent SSE stream
|
||||
|
||||
Authorized Server-Sent Events stream for connected printer agents.
|
||||
Maintains a persistent connection with regular heartbeats (`: heartbeat\n\n`) and updates `lastseen_at` and `agentversion`.
|
||||
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `token` | no | string | Agent auth token if not provided via Authorization header |
|
||||
| `agentversion` | no | string | Current agent version |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Event stream established
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
31
docs/api/routes/agent/pair.get.md
Normal file
31
docs/api/routes/agent/pair.get.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# `GET /agent/pair`
|
||||
|
||||
Public. No cookie required.
|
||||
|
||||
Pair printer agent via query parameters
|
||||
|
||||
Alternative GET endpoint for devices that pair via query parameters.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `authCode` | no | string | Pairing PIN (or pairingpin) |
|
||||
| `pairingpin` | no | string | |
|
||||
| `serial` | no | string | |
|
||||
| `model` | no | string | |
|
||||
| `version` | no | string | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Pairing successful
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Missing or invalid pairing PIN |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
55
docs/api/routes/agent/pair.post.md
Normal file
55
docs/api/routes/agent/pair.post.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# `POST /agent/pair`
|
||||
|
||||
Public. No cookie required.
|
||||
|
||||
Pair printer agent
|
||||
|
||||
Public, unauthorized endpoint used by the printer agent to complete pairing using a 6-digit PIN.
|
||||
Updates `clientserial`, `clientmodel`, and `agentversion`, clears the pairing PIN, and returns a device authentication token.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `pairingpin` | yes | string | |
|
||||
| `clientserial` | no | string | |
|
||||
| `clientmodel` | no | string | |
|
||||
| `agentversion` | no | string | |
|
||||
|
||||
```json
|
||||
{
|
||||
"pairingpin": "123456",
|
||||
"clientserial": "SN-987654321",
|
||||
"clientmodel": "Epson TM-T88VI",
|
||||
"agentversion": "1.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Pairing successful
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"name": "…",
|
||||
"companyId": 1,
|
||||
"token": "…",
|
||||
"pairedAt": "…",
|
||||
"clientserial": "…",
|
||||
"clientmodel": "…",
|
||||
"agentversion": "…",
|
||||
"sort": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Missing or invalid pairing PIN — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
53
docs/api/routes/agent/state.md
Normal file
53
docs/api/routes/agent/state.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# `POST /agent/state`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Post agent state
|
||||
|
||||
Authorized endpoint for the printer agent to report its operational status/telemetry.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `state` | no | | Status text or status object |
|
||||
|
||||
```json
|
||||
{
|
||||
"state": "…"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
State recorded
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"agent": {
|
||||
"id": 1,
|
||||
"companyId": 1,
|
||||
"name": "…",
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
51
docs/api/routes/agentprinter.md
Normal file
51
docs/api/routes/agentprinter.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# `GET /agentprinter`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List agent printers
|
||||
|
||||
Lists agent printers for the authenticated user's selected company,
|
||||
optionally filtered by printer agent ID.
|
||||
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `printeragentId` | no | integer | Optional printer agent ID filter |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of agent printers
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinters": [
|
||||
{
|
||||
"id": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "…",
|
||||
"model": "…",
|
||||
"serial": "…",
|
||||
"enabled": true,
|
||||
"sort": 1,
|
||||
"open": true,
|
||||
"pause": true,
|
||||
"error": true,
|
||||
"online": true,
|
||||
"labelLength": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
35
docs/api/routes/agentprinter/_id.delete.md
Normal file
35
docs/api/routes/agentprinter/_id.delete.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# `DELETE /agentprinter/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete agent printer
|
||||
|
||||
Deletes an agent printer from the selected company.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `agentprinter` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `204`
|
||||
|
||||
Agent printer deleted
|
||||
|
||||
_No content_
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Agent printer not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
48
docs/api/routes/agentprinter/_id.get.md
Normal file
48
docs/api/routes/agentprinter/_id.get.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# `GET /agentprinter/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Get agent printer
|
||||
|
||||
Retrieves a single agent printer by ID.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Agent printer details
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinter": {
|
||||
"id": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "…",
|
||||
"model": "…",
|
||||
"serial": "…",
|
||||
"enabled": true,
|
||||
"sort": 1,
|
||||
"open": true,
|
||||
"pause": true,
|
||||
"error": true,
|
||||
"online": true,
|
||||
"labelLength": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Agent printer not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
67
docs/api/routes/agentprinter/_id.patch.md
Normal file
67
docs/api/routes/agentprinter/_id.patch.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# `PATCH /agentprinter/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Update agent printer
|
||||
|
||||
Updates enabled and/or display order (sort) of an agent printer.
|
||||
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `enabled` | no | boolean | |
|
||||
| `sort` | no | integer | |
|
||||
|
||||
```json
|
||||
{
|
||||
"enabled": true,
|
||||
"sort": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `agentprinter` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated agent printer
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinter": {
|
||||
"id": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "…",
|
||||
"model": "…",
|
||||
"serial": "…",
|
||||
"enabled": true,
|
||||
"sort": 1,
|
||||
"open": true,
|
||||
"pause": true,
|
||||
"error": true,
|
||||
"online": true,
|
||||
"labelLength": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid input or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Agent printer not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
51
docs/api/routes/agentprinter/order.md
Normal file
51
docs/api/routes/agentprinter/order.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# `PUT /agentprinter/order`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Reorder agent printers
|
||||
|
||||
Reorders agent printers for a specific printer agent within the selected company.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `printeragentId` | no | integer | Optional agent id. If omitted, reorders all printers in the company. |
|
||||
| `agentprinterIds` | yes | integer[] | |
|
||||
|
||||
```json
|
||||
{
|
||||
"printeragentId": 1,
|
||||
"agentprinterIds": [
|
||||
1
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `agentprinter` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
Applied order
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinterIds": [
|
||||
1
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid order or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
@@ -17,13 +17,13 @@ Prints a label for the article using a label template.
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `templateId` | yes | integer | |
|
||||
| `printerId` | yes | integer | |
|
||||
| `agentprinterId` | yes | integer | |
|
||||
| `quantity` | yes | integer | |
|
||||
|
||||
```json
|
||||
{
|
||||
"templateId": 1,
|
||||
"printerId": 1,
|
||||
"agentprinterId": 1,
|
||||
"quantity": 1
|
||||
}
|
||||
```
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Replace POS prices by SKU (net > gross; price=net, tax=taxRate %)
|
||||
Replace POS prices by SKU (net > gross)
|
||||
|
||||
Replace-all prices for the company POS customer group.
|
||||
`net` takes precedence over `price` (legacy alias for net) and `gross`.
|
||||
`tax` and `taxRate` both specify the tax rate percentage (e.g. 19 for 19%), not monetary tax.
|
||||
`net` takes precedence over `gross`.
|
||||
`taxRate` specifies the tax rate percentage (e.g. 19 for 19%), not monetary tax.
|
||||
When `gross` is provided, net price is computed as `gross / (1 + taxRate / 100)`.
|
||||
Prices are strictly scoped to the company's designated POS customer group (customergroupId returned on GET).
|
||||
Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.
|
||||
@@ -23,11 +23,9 @@ Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `prices` | yes | object[] | |
|
||||
| `prices[].net` | no | number | Net price (excl. VAT). Either `net`, `gross`, or legacy `price` is required. |
|
||||
| `prices[].net` | no | number | Net price (excl. VAT). Either `net` or `gross` is required. |
|
||||
| `prices[].gross` | no | number | Gross price (incl. VAT). Net is computed as `gross / (1 + taxRate / 100)`. |
|
||||
| `prices[].price` | no | number | Legacy alias for `net`. |
|
||||
| `prices[].taxRate` | no | number | Tax rate percentage (e.g. 19 for 19%, 7 for 7%, 0 for 0%). |
|
||||
| `prices[].tax` | no | number | Alias for `taxRate` percentage. |
|
||||
| `prices[].minmultiplier` | no | number | Defaults to 1; must be unique per request. |
|
||||
|
||||
```json
|
||||
|
||||
@@ -4,7 +4,8 @@ Public. No cookie required.
|
||||
|
||||
Login with Google ID token
|
||||
|
||||
Verifies a Google ID token, checks allowlist (or creates entry when `IMPLICIT_CREATE=true`),
|
||||
Verifies a Google ID token, checks allowlist (or creates entry when `IMPLICIT_CREATE=true`
|
||||
or when the email has a pending auto-invitation),
|
||||
stores Google `sub` and profile image bytes, and sets an HTTP-only `token` cookie.
|
||||
`user.picture` is the profile image as base64 (same as GET /auth/me).
|
||||
|
||||
@@ -43,7 +44,7 @@ Login successful; `token` cookie set
|
||||
|--------|-------------|
|
||||
| 400 | Missing token or Google client not configured — `{"error":"…"}` |
|
||||
| 401 | Invalid Google token or account — `{"error":"…"}` |
|
||||
| 403 | Email not on allowlist — `{"error":"…"}` |
|
||||
| 403 | Email not on allowlist or invited — `{"error":"…"}` |
|
||||
| 500 | Server error — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
@@ -6,7 +6,7 @@ Current user
|
||||
|
||||
Returns the authenticated user from the session cookie and the Google client ID.
|
||||
`user.picture` is the stored profile image as a base64 string when present.
|
||||
Unauthenticated calls still receive `googleClientId` with 401.
|
||||
Unauthenticated calls still receive `googleClientId` and `schemaVersion` with 401.
|
||||
|
||||
|
||||
## Response `200`
|
||||
@@ -21,7 +21,10 @@ Authenticated
|
||||
"selectedCompanyId": 1,
|
||||
"picture": "…"
|
||||
},
|
||||
"googleClientId": "…"
|
||||
"googleClientId": "…",
|
||||
"schemaVersion": 1,
|
||||
"vhost": true,
|
||||
"vhostSettings": "…"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -29,7 +32,7 @@ Authenticated
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized — still includes `googleClientId` for the frontend |
|
||||
| 401 | Unauthorized — still includes `googleClientId` and `schemaVersion` for the frontend |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ Sets the authenticated user's selected company.
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `company` (see [`GET /events`](../events.md)).
|
||||
On success, emits SSE signals: `user`, `company` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
@@ -43,6 +43,7 @@ Updated user
|
||||
|--------|-------------|
|
||||
| 400 | Invalid companyId — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (the user is not a member of this company) — `{"error":"…"}` |
|
||||
| 500 | Server error — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
55
docs/api/routes/autoinvite/create.md
Normal file
55
docs/api/routes/autoinvite/create.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# `POST /autoinvite`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create auto-invitation
|
||||
|
||||
Registers an email for automatic membership. When a user with this email registers,
|
||||
the invitation is removed from the list and the user is added to the company with the given role.
|
||||
Emails that are already registered are rejected (409); use `POST /companyuser` for those. Admin only.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `email` | yes | string | |
|
||||
| `role` | no | string | |
|
||||
|
||||
```json
|
||||
{
|
||||
"email": "newhire@example.com",
|
||||
"role": "user"
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `autoinvite` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created invitation
|
||||
|
||||
```json
|
||||
{
|
||||
"autoinvite": {
|
||||
"id": 1,
|
||||
"email": "…",
|
||||
"role": "admin"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected, invalid email or invalid role — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
| 409 | User already registered or invitation already exists — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
36
docs/api/routes/autoinvite/delete.md
Normal file
36
docs/api/routes/autoinvite/delete.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# `DELETE /autoinvite/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete auto-invitation
|
||||
|
||||
Deletes a pending auto-invitation of the selected company. Admin only.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `autoinvite` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `204`
|
||||
|
||||
Deleted
|
||||
|
||||
_No content_
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid id or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
| 404 | Invitation not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
36
docs/api/routes/autoinvite/list.md
Normal file
36
docs/api/routes/autoinvite/list.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# `GET /autoinvite`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List auto-invitations
|
||||
|
||||
Lists pending auto-invitations of the selected company. Admin only.
|
||||
|
||||
## Response `200`
|
||||
|
||||
Pending invitations
|
||||
|
||||
```json
|
||||
{
|
||||
"autoinvites": [
|
||||
{
|
||||
"id": 1,
|
||||
"email": "…",
|
||||
"role": "admin",
|
||||
"createdAt": "…"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Articles in category
|
||||
|
||||
Returns articles in a category the user is authorized for (omits child articles of a parent article), sorted alphabetically by name. Each article includes `childCount` (the number of its child articles) and small thumbnail fields (`smallThumbW`, `smallThumbH`, `smallThumbBinary`).
|
||||
Returns articles in a category the user is authorized for, sorted alphabetically by name. By default includes child articles (variants); pass `includeChildren=false` to omit them. Each article includes `childCount` (the number of its child articles) and small thumbnail fields (`smallThumbW`, `smallThumbH`, `smallThumbBinary`).
|
||||
|
||||
## Path parameters
|
||||
|
||||
@@ -12,6 +12,12 @@ Returns articles in a category the user is authorized for (omits child articles
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | Category id |
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `includeChildren` | no | boolean | When true (default), includes child articles (variants) alongside parent articles. Set to false to omit child articles. |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Articles list
|
||||
|
||||
@@ -26,7 +26,7 @@ Creates a company and selects it for the current user.
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `company` (see [`GET /events`](../events.md)).
|
||||
On success, emits SSE signals: `user`, `company` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `201`
|
||||
|
||||
@@ -42,7 +42,8 @@ Created; selected company updated
|
||||
"iso639": "…",
|
||||
"taxrate": 1,
|
||||
"reducedtaxrate": 1,
|
||||
"taxfreerate": 1
|
||||
"taxfreerate": 1,
|
||||
"role": "admin"
|
||||
},
|
||||
"user": {
|
||||
"id": 1,
|
||||
@@ -59,6 +60,7 @@ Created; selected company updated
|
||||
|--------|-------------|
|
||||
| 400 | Validation error — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (invited users cannot create companies when implicit create is disabled) — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ Deletes a company.
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `company` (see [`GET /events`](../events.md)).
|
||||
On success, emits SSE signals: `user`, `company` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `204`
|
||||
|
||||
|
||||
@@ -21,7 +21,8 @@ Company list
|
||||
"iso639": "…",
|
||||
"taxrate": 1,
|
||||
"reducedtaxrate": 1,
|
||||
"taxfreerate": 1
|
||||
"taxfreerate": 1,
|
||||
"role": "admin"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -48,7 +48,8 @@ Updated
|
||||
"iso639": "…",
|
||||
"taxrate": 1,
|
||||
"reducedtaxrate": 1,
|
||||
"taxfreerate": 1
|
||||
"taxfreerate": 1,
|
||||
"role": "admin"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
58
docs/api/routes/companyuser/create.md
Normal file
58
docs/api/routes/companyuser/create.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# `POST /companyuser`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Add an existing user to the company
|
||||
|
||||
Adds an existing (registered) user, identified by email, to the selected company. Admin only.
|
||||
The added user can then switch to this company via `PUT /auth/selected-company`.
|
||||
For emails that are not registered yet use `POST /autoinvite`.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `email` | yes | string | |
|
||||
| `role` | no | string | |
|
||||
|
||||
```json
|
||||
{
|
||||
"email": "colleague@example.com",
|
||||
"role": "user"
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `companyuser` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created company user
|
||||
|
||||
```json
|
||||
{
|
||||
"companyuser": {
|
||||
"id": 1,
|
||||
"googleAuthId": 1,
|
||||
"email": "…",
|
||||
"picture": "…",
|
||||
"role": "admin"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected, invalid email or invalid role — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
| 404 | No registered user with this email — `{"error":"…"}` |
|
||||
| 409 | User already in company — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
40
docs/api/routes/companyuser/delete.md
Normal file
40
docs/api/routes/companyuser/delete.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# `DELETE /companyuser/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Remove a user from the company
|
||||
|
||||
Removes a member from the selected company. History entries stay but lose their author link;
|
||||
if the removed user had this company selected, their selection is cleared.
|
||||
The last admin cannot be removed. Admin only.
|
||||
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `companyuser` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `204`
|
||||
|
||||
Removed
|
||||
|
||||
_No content_
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid id or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
| 404 | Company user not found — `{"error":"…"}` |
|
||||
| 409 | Cannot remove the last admin — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
37
docs/api/routes/companyuser/list.md
Normal file
37
docs/api/routes/companyuser/list.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# `GET /companyuser`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List company users
|
||||
|
||||
Lists the members of the selected company with their role. Admin only.
|
||||
|
||||
## Response `200`
|
||||
|
||||
Company members
|
||||
|
||||
```json
|
||||
{
|
||||
"companyusers": [
|
||||
{
|
||||
"id": 1,
|
||||
"googleAuthId": 1,
|
||||
"email": "…",
|
||||
"picture": "…",
|
||||
"role": "admin"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
59
docs/api/routes/companyuser/update.md
Normal file
59
docs/api/routes/companyuser/update.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# `PATCH /companyuser/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Change a company user's role
|
||||
|
||||
Changes the role of a member of the selected company. The last admin cannot be demoted. Admin only.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `role` | yes | string | |
|
||||
|
||||
```json
|
||||
{
|
||||
"role": "admin"
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `companyuser` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated company user
|
||||
|
||||
```json
|
||||
{
|
||||
"companyuser": {
|
||||
"id": 1,
|
||||
"googleAuthId": 1,
|
||||
"email": "…",
|
||||
"picture": "…",
|
||||
"role": "admin"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid id, role or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized (admin of the selected company required) — `{"error":"…"}` |
|
||||
| 404 | Company user not found — `{"error":"…"}` |
|
||||
| 409 | Cannot demote the last admin — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
@@ -6,8 +6,9 @@ Subscribe to update signals (SSE)
|
||||
|
||||
Opens a Server-Sent Events stream for the authenticated user.
|
||||
Can be opened before a company is selected (`selectedCompanyId == null`);
|
||||
when a company is selected or changed, the stream receives a `company`
|
||||
event (`{ companyId }`) and updates its company scope in-place.
|
||||
when a company is selected or changed, the stream receives `user`
|
||||
(`{ selectedCompanyId }`) and `company` (`{ companyId }`) events and
|
||||
updates its company scope in-place.
|
||||
Clients also receive named signals when another request successfully
|
||||
mutates shared data for the active company (including the same
|
||||
browser's other tabs).
|
||||
@@ -16,6 +17,7 @@ Use `EventSource` with credentials so the session cookie is sent:
|
||||
|
||||
```js
|
||||
const es = new EventSource('https://…/api/events', { withCredentials: true });
|
||||
es.addEventListener('user', () => { refetchAuthMe(); });
|
||||
es.addEventListener('company', () => { refetchCompany(); });
|
||||
es.addEventListener('category', () => { refetchCategoryTree(); });
|
||||
es.addEventListener('articles', () => { refetchArticleIndex(); });
|
||||
@@ -27,22 +29,29 @@ Keep-alive comments (`: heartbeat`) are sent roughly every 20s.
|
||||
## Signals
|
||||
|
||||
Every SSE event uses the event name as the signal id; payloads are
|
||||
JSON and most events send an empty object `{}`. `company` emits
|
||||
`{ companyId }` and `brand` emits `{ sender, brandId }`.
|
||||
JSON and most events send an empty object `{}`. `user` emits
|
||||
`{ selectedCompanyId }`, `company` emits `{ companyId }`, and `brand`
|
||||
emits `{ sender, brandId }`.
|
||||
|
||||
| Signal | Payload | Emitted after successful |
|
||||
|--------|---------|--------------------------|
|
||||
| `user` | `{ selectedCompanyId }` | `PUT /auth/selected-company`, `POST /company`, `DELETE /company/{id}` |
|
||||
| `company` | `{ companyId }` | `PUT /auth/selected-company`, `POST /company`, `PUT /company/{id}`, `DELETE /company/{id}` |
|
||||
| `category` | `{}` | `POST /category`, `PATCH /category/{id}`, `PUT /category/order`, `DELETE /category/{id}`, `POST /category/{id}/image`, `DELETE /category/{id}/image`, `PUT /category/{id}/property` |
|
||||
| `articles` | `{}` | `POST /article`, `PATCH /article/{sku}`, `DELETE /article/{sku}`, `PUT /article/{sku}/articles`-style list-level changes, `POST /category/{id}/article` and related article-assigning category mutations |
|
||||
| `article-<sku>` | `{}` | `PUT /article/{sku}/weight`, `PUT /article/{sku}/prices`, `PUT /article/{sku}/eans`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/brand`, `PUT /article/{sku}/images/order`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}`, supplier/article-property mutations affecting the article |
|
||||
| `stock` | `{}` | `POST /stock/adjust` |
|
||||
| `stock` | `{}` | `POST /stock/adjust`, `POST /company/import` (also `category`, `articles`, `brand`, `attributename`, `warehouse`, `carrier`, `supplier`, `order`, `shipment`, `ledger`) |
|
||||
| `ledger` | `{}` | `POST /stock/adjust` |
|
||||
| `attributename` | `{}` | `POST /attributename`, `PUT /attributename/order`, `PATCH /attributename/{id}`, `DELETE /attributename/{id}` |
|
||||
| `propertyname` | `{}` | `POST /propertyname`, `PUT /propertyname/order`, `PATCH /propertyname/{id}`, `DELETE /propertyname/{id}` |
|
||||
| `labeltemplate` | `{}` | `POST /labeltemplate`, `PUT /labeltemplate/{id}`, `PATCH /labeltemplate/{id}`, `DELETE /labeltemplate/{id}` |
|
||||
| `printer` | `{}` | `POST /printer`, `PUT /printer/{id}`, `PATCH /printer/{id}`, `DELETE /printer/{id}` |
|
||||
| `printeragent` | `{}` | `PUT /printeragent`, `PATCH /printeragent/{id}`, `DELETE /printeragent/{id}`, printer agent connect/disconnect/state |
|
||||
| `agentprinter` | `{ printers }` or `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, agent state updates / printer discovery |
|
||||
| `companyuser` | `{}` | `POST /companyuser`, `PATCH /companyuser/{id}`, `DELETE /companyuser/{id}` |
|
||||
| `autoinvite` | `{}` | `POST /autoinvite`, `DELETE /autoinvite/{id}` |
|
||||
| `warehouse` | `{}` | `POST /warehouse`, `PUT /warehouse/{id}`, `PATCH /warehouse/{id}`, `DELETE /warehouse/{id}` |
|
||||
| `supplier` | `{}` | `POST /supplier`, `PATCH /supplier/{id}`, `DELETE /supplier/{id}` |
|
||||
| `vfs` | `{}` | VFS uploads and filesystem mutations such as `POST /vfs/upload`, `POST /vfs/mkdir`, `POST /vfs/rename`, `PUT /vfs/{*path}`, `DELETE /vfs/{*path}` |
|
||||
| `modelconversation` | `{}` | `POST /modelconversation`, `DELETE /modelconversation/{id}` |
|
||||
| `modelconversation-<id>` | `{}` | Conversation-specific updates on the same model conversation thread; the concrete ID is used in the event name |
|
||||
@@ -63,7 +72,8 @@ runtime (for example `article-42000045` and `modelconversation-123`).
|
||||
|
||||
SSE stream (`text/event-stream`). Each signal is an SSE event
|
||||
whose name is the signal id. Most signals send `{}` as data;
|
||||
`company` sends `{ "companyId": 1 }` and `brand` sends
|
||||
`user` sends `{ "selectedCompanyId": 1 }`, `company` sends
|
||||
`{ "companyId": 1 }`, and `brand` sends
|
||||
`{ "sender": "<x-client-id>", "brandId": 12 }`.
|
||||
|
||||
|
||||
|
||||
57
docs/api/routes/labeltemplate/testprint.md
Normal file
57
docs/api/routes/labeltemplate/testprint.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# `POST /labeltemplate/testprint`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Test print label template
|
||||
|
||||
Dispatches a test print job for a label template or unsaved canvas objects to a specified ZPL printer.
|
||||
Placeholders in text and barcodes are interpolated using a sample article or the specified article SKU.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | yes | integer | Agent printer ID |
|
||||
| `templateId` | no | integer | |
|
||||
| `objects` | no | any[] | |
|
||||
| `width` | no | integer | |
|
||||
| `height` | no | integer | |
|
||||
| `dpi` | no | integer | |
|
||||
| `sku` | no | string | |
|
||||
| `quantity` | no | integer | |
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinterId": 1,
|
||||
"templateId": 1,
|
||||
"objects": [],
|
||||
"width": 1,
|
||||
"height": 1,
|
||||
"dpi": 1,
|
||||
"sku": "…",
|
||||
"quantity": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Print job created
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid parameters |
|
||||
| 404 | Printer or template not found |
|
||||
| 500 | Server error |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
@@ -15,6 +15,7 @@ Special API for POS bind and sync.
|
||||
|-------|----------|------|-------------|
|
||||
| `authCode` | yes | string | Discovery code (1-4 digits) or pairing PIN (6 digits) |
|
||||
| `name` | no | string | Client device name or serial identifier (default 'JTL-POS') |
|
||||
| `clientversion` | no | string | Optional client app version (for future POS clients during pairing) |
|
||||
|
||||
## Response `200`
|
||||
|
||||
|
||||
@@ -22,6 +22,9 @@ Posterminal list
|
||||
"clientserial": "…",
|
||||
"rootCategoryId": 1,
|
||||
"syncRootArticles": true,
|
||||
"sort": 1,
|
||||
"enabled": true,
|
||||
"clientversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"categoryIds": [
|
||||
|
||||
@@ -19,6 +19,8 @@ Updates a POS terminal configuration (name, root category, sync settings, or pai
|
||||
| `name` | no | string | |
|
||||
| `rootCategoryId` | no | integer | |
|
||||
| `syncRootArticles` | no | boolean | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
| `pairingpin` | no | string | |
|
||||
|
||||
```json
|
||||
@@ -44,6 +46,9 @@ Updated posterminal
|
||||
"clientserial": "…",
|
||||
"rootCategoryId": 1,
|
||||
"syncRootArticles": true,
|
||||
"sort": 1,
|
||||
"enabled": true,
|
||||
"clientversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"categoryIds": [
|
||||
|
||||
@@ -15,6 +15,8 @@ The pairingpin is randomly generated server-side and returned in the response.
|
||||
| `name` | yes | string | |
|
||||
| `rootCategoryId` | no | integer | |
|
||||
| `syncRootArticles` | no | boolean | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -37,6 +39,9 @@ Created posterminal with generated pairingpin
|
||||
"clientserial": "…",
|
||||
"rootCategoryId": 1,
|
||||
"syncRootArticles": true,
|
||||
"sort": 1,
|
||||
"enabled": true,
|
||||
"clientversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"categoryIds": [
|
||||
|
||||
37
docs/api/routes/printer/_id/state.md
Normal file
37
docs/api/routes/printer/_id/state.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# `GET /printer/{id}/state`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Get live state for a printer
|
||||
|
||||
Retrieves live operational status for a single printer by configured printer ID,
|
||||
serial number, or device identifier for the authenticated user's selected company.
|
||||
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | string | Configured printer ID, serial number, or device identifier |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Live printer state
|
||||
|
||||
```json
|
||||
{
|
||||
"printer": {}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid ID — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Printer not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
39
docs/api/routes/printer/state.md
Normal file
39
docs/api/routes/printer/state.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# `GET /printer/state`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Get live printer states
|
||||
|
||||
Retrieves real-time operational status and telemetry for all discovered printers
|
||||
reported by active printer agents for the authenticated user's selected company.
|
||||
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `serial` | no | string | Optional serial number filter |
|
||||
| `agentId` | no | integer | Optional agent ID filter |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Live printer states
|
||||
|
||||
```json
|
||||
{
|
||||
"printers": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
44
docs/api/routes/printeragent.get.md
Normal file
44
docs/api/routes/printeragent.get.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# `GET /printeragent`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List printer agents
|
||||
|
||||
Lists printer agents for the authenticated user's selected company.
|
||||
|
||||
## Response `200`
|
||||
|
||||
Printer agent list
|
||||
|
||||
```json
|
||||
{
|
||||
"printeragents": [
|
||||
{
|
||||
"id": 1,
|
||||
"companyId": 1,
|
||||
"name": "…",
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid input — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Company not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
58
docs/api/routes/printeragent.put.md
Normal file
58
docs/api/routes/printeragent.put.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# `PUT /printeragent`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create printer agent
|
||||
|
||||
Creates an unpaired printer agent for the selected company.
|
||||
The pairingpin is randomly generated server-side and returned in the response.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `name` | yes | string | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Bar printer"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Created printer agent with generated pairingpin
|
||||
|
||||
```json
|
||||
{
|
||||
"printeragent": {
|
||||
"id": 1,
|
||||
"companyId": 1,
|
||||
"name": "…",
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid input — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Company not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
30
docs/api/routes/printeragent/_id.delete.md
Normal file
30
docs/api/routes/printeragent/_id.delete.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# `DELETE /printeragent/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete printer agent
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `204`
|
||||
|
||||
Deleted
|
||||
|
||||
_No content_
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid id — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Printeragent not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
64
docs/api/routes/printeragent/_id.patch.md
Normal file
64
docs/api/routes/printeragent/_id.patch.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# `PATCH /printeragent/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Update printer agent
|
||||
|
||||
Updates name and/or display order (sort) of a printer agent.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `name` | no | string | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "…",
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated printer agent
|
||||
|
||||
```json
|
||||
{
|
||||
"printeragent": {
|
||||
"id": 1,
|
||||
"companyId": 1,
|
||||
"name": "…",
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid input — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Printeragent not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
46
docs/api/routes/printerjob.get.md
Normal file
46
docs/api/routes/printerjob.get.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# `GET /printerjob`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List printer jobs
|
||||
|
||||
Lists printer jobs for the selected company, optionally filtered by agent printer or state.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | no | integer | Optional agent printer ID filter |
|
||||
| `state` | no | string | Optional job state filter |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of printer jobs
|
||||
|
||||
```json
|
||||
{
|
||||
"printerjobs": [
|
||||
{
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
46
docs/api/routes/printerjob.post.md
Normal file
46
docs/api/routes/printerjob.post.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# `POST /printerjob`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create print job
|
||||
|
||||
Creates a new print job for an agent printer. Notifies the agent in real time.
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | yes | integer | |
|
||||
| `type` | no | string | |
|
||||
| `data` | yes | string | |
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinterId": 1,
|
||||
"type": "zpl",
|
||||
"data": "…"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `201`
|
||||
|
||||
Printer job created
|
||||
|
||||
```json
|
||||
{
|
||||
"printerjob": {
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
39
docs/api/routes/printerjob/_id.delete.md
Normal file
39
docs/api/routes/printerjob/_id.delete.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# `DELETE /printerjob/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Cancel and delete printer job
|
||||
|
||||
Cancels and deletes a print job. If the job was pending or processing, sends a cancellation
|
||||
event to the connected printer agent before deletion.
|
||||
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Job cancelled and deleted
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"deletedJob": {
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
44
docs/api/routes/printerjob/_id.get.md
Normal file
44
docs/api/routes/printerjob/_id.get.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# `GET /printerjob/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Get printer job
|
||||
|
||||
Retrieves details of a specific printer job by ID.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Printer job details
|
||||
|
||||
```json
|
||||
{
|
||||
"printerjob": {
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Printer job not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
37
docs/api/routes/printerjob/_id/cancel.md
Normal file
37
docs/api/routes/printerjob/_id/cancel.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# `POST /printerjob/{id}/cancel`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Cancel printer job
|
||||
|
||||
Marks a print job as cancelled and notifies the connected agent in real time.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Printer job cancelled
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"printerjob": {
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
48
docs/api/routes/printerjob/cancel-all.md
Normal file
48
docs/api/routes/printerjob/cancel-all.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# `POST /printerjob/cancel-all`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Cancel all pending and processing printer jobs
|
||||
|
||||
Cancels all queued or in-flight print jobs for the selected company, optionally filtered by agentprinterId.
|
||||
Notifies connected agents in real time.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | no | integer | |
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinterId": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
All matching jobs cancelled
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"cancelledCount": 1,
|
||||
"jobs": [
|
||||
{
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
@@ -19,6 +19,10 @@ Creates a supplier in the company `Lieferanten` group (created on first use).
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `supplier` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created supplier
|
||||
|
||||
@@ -14,6 +14,10 @@ Related `entityhistory` cascades; `manifest.entity_id` is set null.
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `supplier` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `204`
|
||||
|
||||
Deleted
|
||||
|
||||
@@ -24,6 +24,10 @@ Renames a supplier for the selected company.
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `supplier` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated supplier
|
||||
|
||||
@@ -20,7 +20,7 @@ Applets return typed CSV, not JSON: `result` is a `;`-separated CSV string with
|
||||
response also carries `columns` (name/type) and `rows` (data row count). Only declared columns are
|
||||
emitted, in header order; missing values become empty cells. Execution runs in the same isolated worker
|
||||
sandbox as the `javascript_execute` tool — including authenticated `fetch()` against this API,
|
||||
`fs`/`vfs`, `sharp`, ExcelJS, PDFKit and WebCrypto globals.
|
||||
`fs`/`vfs`, `optimizeImage`, ExcelJS, PDFKit and WebCrypto globals.
|
||||
|
||||
The path is taken from the URL (like `DELETE /vfs/{*path}`); the run arguments are the JSON body.
|
||||
Path traversal (`..`), null bytes, and backslashes are rejected with HTTP 400, as is a path that does
|
||||
|
||||
56
docs/api/routes/zpljob.md
Normal file
56
docs/api/routes/zpljob.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# `POST /zpljob`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create ZPL print job
|
||||
|
||||
Issues a new ZPL print job to an agent printer. If copiescount > 1, the ZPL quantity command (^PQ)
|
||||
is automatically applied. The connected printer agent receives an immediate real-time event.
|
||||
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | yes | integer | Target agent printer ID |
|
||||
| `copiescount` | no | integer | Optional copy count (defaults to 1) |
|
||||
| `data` | yes | string | Raw ZPL string |
|
||||
|
||||
```json
|
||||
{
|
||||
"agentprinterId": 1,
|
||||
"copiescount": 2,
|
||||
"data": "^XA^FO50,50^ADN,36,20^FDHello Zebra^FS^XZ"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `201`
|
||||
|
||||
Print job created
|
||||
|
||||
```json
|
||||
{
|
||||
"printerjob": {
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid input or missing fields — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Agent printer not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
18
docs/dash.sh
18
docs/dash.sh
@@ -1,7 +1,4 @@
|
||||
#!/bin/bash
|
||||
DASH_DIR="/home/ubuntu/src/dash"
|
||||
REPO_DIR="${DASH_DIR}/dashback"
|
||||
|
||||
# Ensure private Docker network exists and sql_server is connected
|
||||
docker network create dash_net 2>/dev/null || true
|
||||
docker network connect dash_net sql_server 2>/dev/null || true
|
||||
@@ -10,15 +7,17 @@ docker rm -f dashback 2>/dev/null
|
||||
|
||||
docker run -d \
|
||||
--name dashback \
|
||||
--restart unless-stopped \
|
||||
--log-opt max-size=10m \
|
||||
--log-opt max-file=3 \
|
||||
--restart always \
|
||||
--network dash_net \
|
||||
--read-only \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=64m \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=512m \
|
||||
--tmpfs /run:rw,noexec,nosuid,size=16m \
|
||||
-u $(id -u):$(id -g) \
|
||||
-p 127.0.0.1:4208:4208 \
|
||||
-p 127.0.0.1:4211:4211 \
|
||||
-e HOST=0.0.0.0 \
|
||||
-e PORT=4208 \
|
||||
-e PORT=4211 \
|
||||
-e HTTPS_PORT=0 \
|
||||
-e MSSQL_SERVER=sql_server \
|
||||
-e HEALTH_MONITOR_ENABLED=false \
|
||||
@@ -28,6 +27,7 @@ docker run -d \
|
||||
-e GOOGLE_CLIENT_ID=928121624463-m9du45ek2d5f6p9cke8qpnf89ii9no20.apps.googleusercontent.com \
|
||||
-e JWT_SECRET=dfhjkswezui32476sdjkhvbn347865 \
|
||||
-e IMPLICIT_CREATE=true \
|
||||
-e VHOST_SETTINGS="" \
|
||||
-e DB_PROVIDER=mssql \
|
||||
-e MSSQL_DATABASE=dashback \
|
||||
-e MSSQL_USER=sa \
|
||||
@@ -35,5 +35,7 @@ docker run -d \
|
||||
-e MSSQL_PORT=1433 \
|
||||
-e MSSQL_ENCRYPT=false \
|
||||
-e MSSQL_TRUST_SERVER_CERTIFICATE=false \
|
||||
-v "${REPO_DIR}/data:/app/data:rw" \
|
||||
-v "/home/ubuntu/src/docker/dashback_data:/app/data:rw" \
|
||||
-v "/home/ubuntu/src/docker/dashback/dist:/app/dist:ro" \
|
||||
-v "/home/ubuntu/src/docker/dashback/dist/dashback_current:/app/dist/dashback:ro" \
|
||||
dashback:latest
|
||||
|
||||
@@ -3,9 +3,11 @@ docker rm -f dashdemo 2>/dev/null
|
||||
|
||||
docker run -d \
|
||||
--name dashdemo \
|
||||
--restart unless-stopped \
|
||||
--log-opt max-size=10m \
|
||||
--log-opt max-file=3 \
|
||||
--restart always \
|
||||
--read-only \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=64m \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=512m \
|
||||
--tmpfs /run:rw,noexec,nosuid,size=16m \
|
||||
-u $(id -u):$(id -g) \
|
||||
-p 127.0.0.1:4209:4209 \
|
||||
@@ -20,4 +22,6 @@ docker run -d \
|
||||
-e JWT_SECRET=dfhjkswezui32476sdjkhvbn347865 \
|
||||
-e IMPLICIT_CREATE=true \
|
||||
-v "/home/ubuntu/dashdemo:/app/data:rw" \
|
||||
-v "/home/ubuntu/src/docker/dashback/dist:/app/dist:ro" \
|
||||
-v "/home/ubuntu/src/docker/dashback/dist/dashback_current:/app/dist/dashback:ro" \
|
||||
dashback:latest
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
docker run -d \
|
||||
--name sql_server \
|
||||
--restart unless-stopped \
|
||||
--restart always \
|
||||
-e "ACCEPT_EULA=Y" \
|
||||
-e "MSSQL_PID=Standard" \
|
||||
-e "MSSQL_SA_PASSWORD=420Green" \
|
||||
-e "MSSQL_COLLATION=Latin1_General_CI_AS" \
|
||||
-p 127.0.0.1:1433:1433 \
|
||||
-p 192.168.122.1:1433:1433 \
|
||||
-v /home/ubuntu/mssql_data:/var/opt/mssql \
|
||||
-v /home/ubuntu/shared_backups:/shared \
|
||||
mcr.microsoft.com/mssql/server:2025-latest
|
||||
|
||||
74
docs/update.sh
Executable file
74
docs/update.sh
Executable file
@@ -0,0 +1,74 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
|
||||
echo "=== 1. Pulling latest changes in all repositories ==="
|
||||
for dir in "$ROOT_DIR"/*/; do
|
||||
if [ -d "${dir}.git" ]; then
|
||||
repo_name="$(basename "$dir")"
|
||||
echo "-> git pull in ${repo_name}"
|
||||
git -C "$dir" pull
|
||||
fi
|
||||
done
|
||||
|
||||
echo "=== 2. Running npm ci in dashfront, dashdbschema, and dashback ==="
|
||||
for pkg in dashfront dashdbschema dashback; do
|
||||
echo "-> npm ci in ${pkg}"
|
||||
npm --prefix "${ROOT_DIR}/${pkg}" ci
|
||||
done
|
||||
|
||||
echo "=== 3. Building dashfront ==="
|
||||
npm --prefix "${ROOT_DIR}/dashfront" run build
|
||||
|
||||
echo "=== 4. Building SEA in dashback ==="
|
||||
npm --prefix "${ROOT_DIR}/dashback" run sea
|
||||
|
||||
DOCKER_DIST_DIR="/home/ubuntu/src/docker/dashback/dist"
|
||||
mkdir -p "$DOCKER_DIST_DIR"
|
||||
TIMESTAMP="$(date +%Y%m%d%H%M%S)"
|
||||
NEW_SEA="${DOCKER_DIST_DIR}/dashback_${TIMESTAMP}"
|
||||
CURRENT_SEA="${DOCKER_DIST_DIR}/dashback_current"
|
||||
PREV_SEA="$(readlink -f "$CURRENT_SEA" 2>/dev/null || true)"
|
||||
|
||||
echo "-> Copying SEA to ${NEW_SEA} and linking ${CURRENT_SEA}..."
|
||||
touch "${DOCKER_DIST_DIR}/dashback"
|
||||
cp "${ROOT_DIR}/dashback/dist/dashback" "$NEW_SEA"
|
||||
chmod +x "$NEW_SEA"
|
||||
ln -sfn "$NEW_SEA" "$CURRENT_SEA"
|
||||
|
||||
echo "=== 5. Running self-test on dashback_current in test container ==="
|
||||
exec 3>&1
|
||||
set +e
|
||||
SELFTEST_OUTPUT=$(docker run --rm \
|
||||
--read-only \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=512m \
|
||||
--tmpfs /run:rw,noexec,nosuid,size=16m \
|
||||
--tmpfs /app/data:rw,noexec,nosuid,size=64m \
|
||||
-u "$(id -u):$(id -g)" \
|
||||
-v "${DOCKER_DIST_DIR}:/app/dist:ro" \
|
||||
-v "${CURRENT_SEA}:/app/dist/dashback:ro" \
|
||||
dashback:latest \
|
||||
./dist/dashback --selftest 2>&1 | tee /dev/fd/3; exit "${PIPESTATUS[0]}")
|
||||
SELFTEST_EXIT=$?
|
||||
set -e
|
||||
exec 3>&-
|
||||
|
||||
if [ "$SELFTEST_EXIT" -ne 0 ] || ! grep -q "Self-test PASSED" <<< "$SELFTEST_OUTPUT"; then
|
||||
echo "ERROR: Self-test did not confirm 'Self-test PASSED'. Aborting container restart." >&2
|
||||
if [ -n "$PREV_SEA" ] && [ -f "$PREV_SEA" ]; then
|
||||
echo "-> Restoring ${CURRENT_SEA} to ${PREV_SEA}..." >&2
|
||||
ln -sfn "$PREV_SEA" "$CURRENT_SEA"
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "=== 6. Restarting dashback containers ==="
|
||||
CONTAINERS=$(docker ps -q --filter "ancestor=dashback:latest")
|
||||
if [ -n "$CONTAINERS" ]; then
|
||||
echo "-> Restarting dashback containers ($(docker ps --filter "ancestor=dashback:latest" --format '{{.Names}}' | paste -sd ', ' -))..."
|
||||
docker restart $CONTAINERS
|
||||
fi
|
||||
|
||||
echo "=== Update complete! ==="
|
||||
|
||||
1040
package-lock.json
generated
1040
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
11
package.json
11
package.json
@@ -9,13 +9,17 @@
|
||||
"scripts": {
|
||||
"start": "node src/index.js",
|
||||
"dev": "cross-env DEV_BACKEND_MONITOR=true node --watch-path=./src --watch-path=./.env --watch-path=../dashdbschema/src --watch-path=../llmorbiter/src src/index.js",
|
||||
"self-test": "node src/index.js --self-test",
|
||||
"manage-users": "node scripts/manageUsers.js",
|
||||
"wipe-company": "node scripts/wipeCompany.js",
|
||||
"downgrade": "node scripts/downgradeSchema.js",
|
||||
"docs:api": "node scripts/generateApiDocs.js",
|
||||
"api-graph": "node generate-api-graph.js",
|
||||
"review:functions": "node scripts/extractFunctions.js",
|
||||
"build:sea": "node scripts/buildSea.js",
|
||||
"sea": "npm run build:sea",
|
||||
"docker:build": "docker build -t dashback:latest -t dashback:1.0.0 .",
|
||||
"docker": "npm run docker:build",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"dependencies": {
|
||||
@@ -39,12 +43,12 @@
|
||||
"pdfconvert-wasm": "^0.3.0",
|
||||
"pdfkit": "^0.20.2",
|
||||
"react": "^19.3.1",
|
||||
"react-canvas-label-editor": "github:sebseb7/react-canvas-label-editor",
|
||||
"react-canvas-label-editor": "github:sebseb7/react-canvas-label-editor#v20.0.0",
|
||||
"selfsigned": "^5.5.0",
|
||||
"sharp": "^0.35.5",
|
||||
"skelehash-wasm": "^0.1.1",
|
||||
"swagger-ui-dist": "^5.33.3",
|
||||
"vm2": "^3.12.2",
|
||||
"wasm-image-optimization": "^2.0.13",
|
||||
"zod": "^4.6.7"
|
||||
},
|
||||
"devDependencies": {
|
||||
@@ -53,8 +57,7 @@
|
||||
"swagger-jsdoc": "^6.3.0"
|
||||
},
|
||||
"allowScripts": {
|
||||
"github:sebseb7/react-canvas-label-editor#7f0e31b66ff22da011e872b201017398b14e9dd9": true,
|
||||
"canvas@3.2.3": true,
|
||||
"react-canvas-label-editor@20.0.0": true,
|
||||
"better-sqlite3@13.0.3": true
|
||||
},
|
||||
"overrides": {
|
||||
|
||||
@@ -18,7 +18,55 @@ if (!fs.existsSync(distDir)) {
|
||||
fs.mkdirSync(distDir, { recursive: true });
|
||||
}
|
||||
|
||||
console.log('Packaging application, siblings, and dependencies into SEA payload...');
|
||||
console.log('Packaging application, siblings, and JavaScript dependencies into SEA payload (excluding native binaries)...');
|
||||
|
||||
const nativeNodes = {};
|
||||
|
||||
function findNearestPackageJson(startDir) {
|
||||
let dir = startDir;
|
||||
while (dir && dir !== path.dirname(dir)) {
|
||||
const pkgFile = path.join(dir, 'package.json');
|
||||
if (fs.existsSync(pkgFile)) {
|
||||
try {
|
||||
return JSON.parse(fs.readFileSync(pkgFile, 'utf8'));
|
||||
} catch {}
|
||||
}
|
||||
dir = path.dirname(dir);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getVersionedNodeFilename(fullPath) {
|
||||
const base = path.basename(fullPath, '.node');
|
||||
const pkg = findNearestPackageJson(path.dirname(fullPath));
|
||||
if (!pkg || !pkg.name || !pkg.version) {
|
||||
return `${base}.node`;
|
||||
}
|
||||
const shortName = pkg.name.replace(/^@[^/]+\//, '');
|
||||
if (base.includes(pkg.version)) {
|
||||
return `${base}.node`;
|
||||
}
|
||||
if (base === shortName) {
|
||||
return `${shortName}-${process.platform}-${process.arch}-${pkg.version}.node`;
|
||||
}
|
||||
return `${shortName}-${base}-${pkg.version}.node`;
|
||||
}
|
||||
|
||||
function isNativeBinary(name) {
|
||||
return (
|
||||
name.endsWith('.node') ||
|
||||
name.endsWith('.so') ||
|
||||
name.includes('.so.') ||
|
||||
name.endsWith('.dylib') ||
|
||||
name.endsWith('.dll') ||
|
||||
name.endsWith('.a') ||
|
||||
name.endsWith('.o') ||
|
||||
name.endsWith('.cc') ||
|
||||
name.endsWith('.cpp') ||
|
||||
name.endsWith('.c') ||
|
||||
name.endsWith('.h')
|
||||
);
|
||||
}
|
||||
|
||||
function packDirectory(dir, prefix, result) {
|
||||
if (!fs.existsSync(dir)) return;
|
||||
@@ -30,7 +78,11 @@ function packDirectory(dir, prefix, result) {
|
||||
if (entry.name === 'test' || entry.name === 'tests' || entry.name === 'docs' || entry.name === '.github' || entry.name === '.git' || entry.name === 'obj.target') continue;
|
||||
packDirectory(full, rel, result);
|
||||
} else if (entry.isFile()) {
|
||||
if (entry.name.endsWith('.a') || entry.name.endsWith('.o') || entry.name.endsWith('.cc') || entry.name.endsWith('.cpp') || entry.name.endsWith('.c') || entry.name.endsWith('.h')) continue;
|
||||
if (entry.name.endsWith('.node')) {
|
||||
nativeNodes[rel] = getVersionedNodeFilename(full);
|
||||
continue;
|
||||
}
|
||||
if (isNativeBinary(entry.name)) continue;
|
||||
result[rel] = fs.readFileSync(full).toString('base64');
|
||||
}
|
||||
}
|
||||
@@ -82,6 +134,8 @@ function packNodeModules(nmPath) {
|
||||
packNodeModules(path.join(rootDir, 'node_modules'));
|
||||
packNodeModules(path.join(dbschemaDir, 'node_modules'));
|
||||
|
||||
payload['.native-nodes.json'] = Buffer.from(JSON.stringify(nativeNodes)).toString('base64');
|
||||
|
||||
const compressedPayload = zlib.deflateSync(Buffer.from(JSON.stringify(payload)));
|
||||
fs.writeFileSync(payloadPath, compressedPayload);
|
||||
|
||||
|
||||
30
scripts/downgradeSchema.js
Normal file
30
scripts/downgradeSchema.js
Normal file
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* Downgrades the configured database (from `.env`) to a target schema version.
|
||||
*
|
||||
* npm run downgrade -- <targetVersion>
|
||||
*
|
||||
* Uses libdashstore's `src/providers/<provider>/downgrade/<from>_to_<to>.js`.
|
||||
* Stop the API first; starting it again upgrades back to the latest version.
|
||||
*/
|
||||
import { createProvider } from '../src/db/provider.js';
|
||||
import env from '../src/config/env.js';
|
||||
|
||||
const [rawTarget] = process.argv.slice(2);
|
||||
const target = Number(rawTarget);
|
||||
if (!rawTarget || !Number.isInteger(target) || target < 1) {
|
||||
console.error('Usage: npm run downgrade -- <targetVersion>');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const provider = createProvider();
|
||||
try {
|
||||
const before = await provider.getSchemaVersion();
|
||||
const steps = await provider.downgradeSchema(target);
|
||||
console.log(`Schema ${env.dbProvider}: ${before} -> ${target} (${steps} step(s))`);
|
||||
} catch (err) {
|
||||
console.error(`Downgrade failed: ${err.message}`);
|
||||
process.exitCode = 1;
|
||||
} finally {
|
||||
await provider.close();
|
||||
}
|
||||
|
||||
@@ -39,13 +39,16 @@ const OMITTED_ROUTES = new Set([
|
||||
'POST /serper/image',
|
||||
'POST /serper/images',
|
||||
'GET /shipment/{id}/file/{fileId}',
|
||||
'GET /smallthumb/{fullHash}',
|
||||
'GET /thumb/{fullHash}',
|
||||
'GET /v1/category',
|
||||
'GET /v1/cimage',
|
||||
'GET /v1/client',
|
||||
'GET /v1/customer',
|
||||
'GET /v1/customergroup',
|
||||
'GET /v1/deletedentity',
|
||||
'GET /v1/init',
|
||||
'POST /v1/order',
|
||||
'GET /v1/pimage',
|
||||
'GET /v1/product',
|
||||
]);
|
||||
@@ -81,6 +84,36 @@ function isRouteOmitted(method, apiPath) {
|
||||
if (apiPath === '/auth' || apiPath.startsWith('/auth/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/agent' || apiPath.startsWith('/agent/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/agentprinter' || apiPath.startsWith('/agentprinter/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/printer' || apiPath.startsWith('/printer/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/printeragent' || apiPath.startsWith('/printeragent/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/printerjob' || apiPath.startsWith('/printerjob/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/smallthumb' || apiPath.startsWith('/smallthumb/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/v1' || apiPath.startsWith('/v1/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/health' || apiPath.startsWith('/health/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/subagentschedule' || apiPath.startsWith('/subagentschedule/')) {
|
||||
return true;
|
||||
}
|
||||
if (apiPath === '/zpljob' || apiPath.startsWith('/zpljob/')) {
|
||||
return true;
|
||||
}
|
||||
return OMITTED_ROUTES.has(`${method.toUpperCase()} ${apiPath}`);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,92 +0,0 @@
|
||||
-- Rename article "father" columns to "parent" (SQL Server / MSSQL).
|
||||
--
|
||||
-- One-off manual migration (no migration code is kept in the repo).
|
||||
-- sqlcmd -S <server> -d <db> -E -i scripts/migrate-parent-rename.mssql.sql
|
||||
--
|
||||
-- Guarded and safe to re-run. Safe to retry after a partial run.
|
||||
--
|
||||
-- NOTE ON BATCHING: sp_rename is deferred and its effect is not visible to
|
||||
-- subsequent statements in the SAME batch. Each rename therefore runs in its
|
||||
-- own batch (GO), and constraint/index recreation happens after a GO so the
|
||||
-- new column names resolve.
|
||||
|
||||
SET XACT_ABORT ON;
|
||||
GO
|
||||
|
||||
BEGIN TRANSACTION;
|
||||
GO
|
||||
|
||||
-- Drop the old filtered unique index (references fathersort).
|
||||
IF EXISTS (SELECT 1 FROM sys.indexes WHERE name = 'UQ_article_fatherarticle_fathersort')
|
||||
DROP INDEX UQ_article_fatherarticle_fathersort ON article;
|
||||
GO
|
||||
|
||||
-- Drop the default constraints bound to the old column names.
|
||||
IF EXISTS (SELECT 1 FROM sys.default_constraints WHERE name = 'DF_article_is_father')
|
||||
ALTER TABLE article DROP CONSTRAINT DF_article_is_father;
|
||||
IF EXISTS (SELECT 1 FROM sys.default_constraints WHERE name = 'DF_article_fathersort')
|
||||
ALTER TABLE article DROP CONSTRAINT DF_article_fathersort;
|
||||
GO
|
||||
|
||||
-- Drop foreign keys bound to the old columns.
|
||||
IF EXISTS (SELECT 1 FROM sys.foreign_keys WHERE name = 'FK_article_fatherarticle')
|
||||
ALTER TABLE article DROP CONSTRAINT FK_article_fatherarticle;
|
||||
IF EXISTS (SELECT 1 FROM sys.foreign_keys WHERE name = 'FK_article_fatherattributename')
|
||||
ALTER TABLE article DROP CONSTRAINT FK_article_fatherattributename;
|
||||
GO
|
||||
|
||||
-- Rename the columns (each sp_rename must be its own batch).
|
||||
IF COL_LENGTH('article', 'fatherarticle_id') IS NOT NULL
|
||||
AND COL_LENGTH('article', 'parentarticle_id') IS NULL
|
||||
EXEC sp_rename 'article.fatherarticle_id', 'parentarticle_id', 'COLUMN';
|
||||
GO
|
||||
|
||||
IF COL_LENGTH('article', 'fatherattributename_id') IS NOT NULL
|
||||
AND COL_LENGTH('article', 'parentattributename_id') IS NULL
|
||||
EXEC sp_rename 'article.fatherattributename_id', 'parentattributename_id', 'COLUMN';
|
||||
GO
|
||||
|
||||
IF COL_LENGTH('article', 'fathersort') IS NOT NULL
|
||||
AND COL_LENGTH('article', 'parentsort') IS NULL
|
||||
EXEC sp_rename 'article.fathersort', 'parentsort', 'COLUMN';
|
||||
GO
|
||||
|
||||
IF COL_LENGTH('article', 'is_father') IS NOT NULL
|
||||
AND COL_LENGTH('article', 'is_parent') IS NULL
|
||||
EXEC sp_rename 'article.is_father', 'is_parent', 'COLUMN';
|
||||
GO
|
||||
|
||||
COMMIT TRANSACTION;
|
||||
GO
|
||||
|
||||
-- Recreate the constraints under their new names (after the rename batches).
|
||||
IF NOT EXISTS (SELECT 1 FROM sys.foreign_keys WHERE name = 'FK_article_parentarticle')
|
||||
ALTER TABLE article ADD CONSTRAINT FK_article_parentarticle
|
||||
FOREIGN KEY (parentarticle_id) REFERENCES article(id) ON DELETE NO ACTION;
|
||||
GO
|
||||
|
||||
IF NOT EXISTS (SELECT 1 FROM sys.foreign_keys WHERE name = 'FK_article_parentattributename')
|
||||
ALTER TABLE article ADD CONSTRAINT FK_article_parentattributename
|
||||
FOREIGN KEY (parentattributename_id) REFERENCES attributename(id) ON DELETE NO ACTION;
|
||||
GO
|
||||
|
||||
IF NOT EXISTS (SELECT 1 FROM sys.default_constraints WHERE name = 'DF_article_is_parent')
|
||||
ALTER TABLE article ADD CONSTRAINT DF_article_is_parent DEFAULT (0) FOR is_parent;
|
||||
GO
|
||||
|
||||
IF NOT EXISTS (SELECT 1 FROM sys.default_constraints WHERE name = 'DF_article_parentsort')
|
||||
ALTER TABLE article ADD CONSTRAINT DF_article_parentsort DEFAULT (0) FOR parentsort;
|
||||
GO
|
||||
|
||||
IF NOT EXISTS (SELECT 1 FROM sys.indexes WHERE name = 'UQ_article_parentarticle_parentsort')
|
||||
CREATE UNIQUE INDEX UQ_article_parentarticle_parentsort
|
||||
ON article (parentarticle_id, parentsort)
|
||||
WHERE parentarticle_id IS NOT NULL;
|
||||
GO
|
||||
|
||||
-- Verify
|
||||
SELECT 'COL:' + c.name AS result
|
||||
FROM sys.columns c
|
||||
WHERE c.object_id = OBJECT_ID('article')
|
||||
AND (c.name LIKE '%father%' OR c.name LIKE '%parent%');
|
||||
GO
|
||||
@@ -1,14 +0,0 @@
|
||||
-- Rename article "father" columns to "parent".
|
||||
--
|
||||
-- One-off manual migration (no migration code is kept in the repo).
|
||||
-- sqlite3 data/dash.db < scripts/migrate-parent-rename.sqlite.sql
|
||||
--
|
||||
-- Safe to re-run: every step is guarded by a column-existence check.
|
||||
|
||||
ALTER TABLE article RENAME COLUMN fatherarticle_id TO parentarticle_id;
|
||||
ALTER TABLE article RENAME COLUMN fatherattributename_id TO parentattributename_id;
|
||||
ALTER TABLE article RENAME COLUMN fathersort TO parentsort;
|
||||
ALTER TABLE article RENAME COLUMN is_father TO is_parent;
|
||||
|
||||
-- Verify
|
||||
PRAGMA table_info(article);
|
||||
@@ -1,73 +1,46 @@
|
||||
#!/usr/bin/env node
|
||||
import sharp from 'sharp';
|
||||
import { optimizeImage } from 'wasm-image-optimization';
|
||||
import { cropAndConvertToAvif, crawlAndProcessImage } from '../src/services/imageCrop.js';
|
||||
|
||||
async function run() {
|
||||
console.log('--- 1. Testing synthetic images ---');
|
||||
|
||||
// Synthetic test 1: White border
|
||||
const whiteImg = await sharp({
|
||||
create: { width: 300, height: 300, channels: 4, background: { r: 255, g: 255, b: 255, alpha: 1 } },
|
||||
})
|
||||
.composite([
|
||||
{
|
||||
input: Buffer.from('<svg width="100" height="100"><rect width="100" height="100" fill="purple"/></svg>'),
|
||||
top: 100,
|
||||
left: 100,
|
||||
},
|
||||
])
|
||||
.png()
|
||||
.toBuffer();
|
||||
const whiteSvg = `<svg xmlns="http://www.w3.org/2000/svg" width="300" height="300">
|
||||
<rect width="300" height="300" fill="#ffffff"/>
|
||||
<rect x="100" y="100" width="100" height="100" fill="purple"/>
|
||||
</svg>`;
|
||||
const whiteImg = Buffer.from((await optimizeImage({ image: whiteSvg, format: 'png' })).data);
|
||||
|
||||
const res1 = await cropAndConvertToAvif(whiteImg);
|
||||
console.log(`White border: 300x300 -> ${res1.width}x${res1.height}, ${res1.size} bytes`);
|
||||
if (res1.width !== 100 || res1.height !== 100) {
|
||||
throw new Error(`Expected 100x100, got ${res1.width}x${res1.height}`);
|
||||
if (res1.width !== 110 || res1.height !== 110) {
|
||||
throw new Error(`Expected 110x110, got ${res1.width}x${res1.height}`);
|
||||
}
|
||||
|
||||
// Synthetic test 2: Transparent border
|
||||
const transImg = await sharp({
|
||||
create: { width: 300, height: 300, channels: 4, background: { r: 0, g: 0, b: 0, alpha: 0 } },
|
||||
})
|
||||
.composite([
|
||||
{
|
||||
input: Buffer.from('<svg width="120" height="80"><rect width="120" height="80" fill="green"/></svg>'),
|
||||
top: 110,
|
||||
left: 90,
|
||||
},
|
||||
])
|
||||
.png()
|
||||
.toBuffer();
|
||||
const transSvg = `<svg xmlns="http://www.w3.org/2000/svg" width="300" height="300">
|
||||
<rect x="90" y="110" width="120" height="80" fill="green"/>
|
||||
</svg>`;
|
||||
const transImg = Buffer.from((await optimizeImage({ image: transSvg, format: 'png' })).data);
|
||||
|
||||
const res2 = await cropAndConvertToAvif(transImg);
|
||||
console.log(`Transparent border: 300x300 -> ${res2.width}x${res2.height}, ${res2.size} bytes`);
|
||||
if (res2.width !== 120 || res2.height !== 80) {
|
||||
throw new Error(`Expected 120x80, got ${res2.width}x${res2.height}`);
|
||||
if (res2.width !== 130 || res2.height !== 90) {
|
||||
throw new Error(`Expected 130x90, got ${res2.width}x${res2.height}`);
|
||||
}
|
||||
|
||||
// Synthetic test 3: Outer transparent, inner white border
|
||||
const mixedImg = await sharp({
|
||||
create: { width: 400, height: 400, channels: 4, background: { r: 0, g: 0, b: 0, alpha: 0 } },
|
||||
})
|
||||
.composite([
|
||||
{
|
||||
input: Buffer.from('<svg width="200" height="200"><rect width="200" height="200" fill="white"/></svg>'),
|
||||
top: 100,
|
||||
left: 100,
|
||||
},
|
||||
{
|
||||
input: Buffer.from('<svg width="100" height="60"><rect width="100" height="60" fill="blue"/></svg>'),
|
||||
top: 170,
|
||||
left: 150,
|
||||
},
|
||||
])
|
||||
.png()
|
||||
.toBuffer();
|
||||
const mixedSvg = `<svg xmlns="http://www.w3.org/2000/svg" width="400" height="400">
|
||||
<rect x="100" y="100" width="200" height="200" fill="white"/>
|
||||
<rect x="150" y="170" width="100" height="60" fill="blue"/>
|
||||
</svg>`;
|
||||
const mixedImg = Buffer.from((await optimizeImage({ image: mixedSvg, format: 'png' })).data);
|
||||
|
||||
const res3 = await cropAndConvertToAvif(mixedImg);
|
||||
console.log(`Mixed border: 400x400 -> ${res3.width}x${res3.height}, ${res3.size} bytes`);
|
||||
if (res3.width !== 100 || res3.height !== 60) {
|
||||
throw new Error(`Expected 100x60, got ${res3.width}x${res3.height}`);
|
||||
if (res3.width !== 110 || res3.height !== 70) {
|
||||
throw new Error(`Expected 110x70, got ${res3.width}x${res3.height}`);
|
||||
}
|
||||
|
||||
console.log('\nAll synthetic tests PASSED!');
|
||||
|
||||
520
src/api/agent/index.js
Normal file
520
src/api/agent/index.js
Normal file
@@ -0,0 +1,520 @@
|
||||
import express from 'express';
|
||||
import crypto from 'node:crypto';
|
||||
import * as db from '../../db/printeragent.js';
|
||||
import * as agentprinterDb from '../../db/agentprinter.js';
|
||||
import * as printerjobDb from '../../db/printerjob.js';
|
||||
import { agentAuthMiddleware, extractAgentVersion } from '../middleware/agentAuth.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { createLogger } from '../../util/logger.js';
|
||||
import {
|
||||
enrichAgentWithState,
|
||||
getAgentState,
|
||||
setAgentState,
|
||||
} from './stateStore.js';
|
||||
import {
|
||||
updateAgentPrinters,
|
||||
removeAgentPrinters,
|
||||
getCompanyPrinters,
|
||||
} from '../../services/companyPrinterService.js';
|
||||
|
||||
const log = createLogger('agent');
|
||||
|
||||
export const agentRouter = express.Router();
|
||||
|
||||
/**
|
||||
* Helper to extract pairing parameters from body or query.
|
||||
*/
|
||||
function extractPairParams(req) {
|
||||
const rawPin = req.body?.pairingpin ||
|
||||
req.body?.authCode ||
|
||||
req.body?.pin ||
|
||||
req.body?.code ||
|
||||
req.query?.pairingpin ||
|
||||
req.query?.authCode ||
|
||||
req.query?.pin ||
|
||||
req.query?.code ||
|
||||
'';
|
||||
const pairingpin = String(rawPin).trim();
|
||||
|
||||
const rawSerial = req.body?.clientserial ||
|
||||
req.body?.serial ||
|
||||
req.body?.name ||
|
||||
req.query?.clientserial ||
|
||||
req.query?.serial ||
|
||||
req.query?.name ||
|
||||
null;
|
||||
const clientserial = rawSerial ? String(rawSerial).trim() : null;
|
||||
|
||||
const rawModel = req.body?.clientmodel ||
|
||||
req.body?.model ||
|
||||
req.query?.clientmodel ||
|
||||
req.query?.model ||
|
||||
null;
|
||||
const clientmodel = rawModel ? String(rawModel).trim() : null;
|
||||
|
||||
const agentversion = extractAgentVersion(req);
|
||||
|
||||
return { pairingpin, clientserial, clientmodel, agentversion };
|
||||
}
|
||||
|
||||
async function handlePair(req, res) {
|
||||
const { pairingpin, clientserial, clientmodel, agentversion } = extractPairParams(req);
|
||||
|
||||
if (!pairingpin) {
|
||||
return res.status(400).json({ error: 'pairingpin is required' });
|
||||
}
|
||||
|
||||
try {
|
||||
const agent = await db.findByPairingpin(pairingpin);
|
||||
if (!agent) {
|
||||
return res.status(400).json({ error: 'Invalid pairing PIN' });
|
||||
}
|
||||
|
||||
const token = crypto.randomBytes(32).toString('hex');
|
||||
const pairedAt = new Date().toISOString();
|
||||
|
||||
const paired = await db.pair(agent.id, {
|
||||
token,
|
||||
clientserial,
|
||||
clientmodel,
|
||||
agentversion,
|
||||
pairedAt,
|
||||
});
|
||||
|
||||
if (paired.companyId) {
|
||||
emit('printeragent', { companyId: paired.companyId });
|
||||
}
|
||||
|
||||
return res.status(200).json({
|
||||
id: paired.id,
|
||||
name: paired.name,
|
||||
companyId: paired.companyId,
|
||||
token,
|
||||
pairedAt: paired.pairedAt,
|
||||
clientserial: paired.clientserial,
|
||||
clientmodel: paired.clientmodel,
|
||||
agentversion: paired.agentversion,
|
||||
sort: paired.sort,
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('Agent pairing failed:', err);
|
||||
return res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agent/pair:
|
||||
* post:
|
||||
* tags: [Agent]
|
||||
* summary: Pair printer agent
|
||||
* description: |
|
||||
* Public, unauthorized endpoint used by the printer agent to complete pairing using a 6-digit PIN.
|
||||
* Updates `clientserial`, `clientmodel`, and `agentversion`, clears the pairing PIN, and returns a device authentication token.
|
||||
* security: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [pairingpin]
|
||||
* properties:
|
||||
* pairingpin:
|
||||
* type: string
|
||||
* example: "123456"
|
||||
* clientserial:
|
||||
* type: string
|
||||
* example: "SN-987654321"
|
||||
* clientmodel:
|
||||
* type: string
|
||||
* example: "Epson TM-T88VI"
|
||||
* agentversion:
|
||||
* type: string
|
||||
* example: "1.0.0"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Pairing successful
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* name:
|
||||
* type: string
|
||||
* companyId:
|
||||
* type: integer
|
||||
* token:
|
||||
* type: string
|
||||
* pairedAt:
|
||||
* type: string
|
||||
* clientserial:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* clientmodel:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* agentversion:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* sort:
|
||||
* type: integer
|
||||
* 400:
|
||||
* description: Missing or invalid pairing PIN
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* get:
|
||||
* tags: [Agent]
|
||||
* summary: Pair printer agent via query parameters
|
||||
* description: Alternative GET endpoint for devices that pair via query parameters.
|
||||
* security: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: authCode
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Pairing PIN (or pairingpin)
|
||||
* - in: query
|
||||
* name: pairingpin
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: serial
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: model
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: version
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Pairing successful
|
||||
* 400:
|
||||
* description: Missing or invalid pairing PIN
|
||||
*/
|
||||
agentRouter.post('/pair', handlePair);
|
||||
agentRouter.get('/pair', handlePair);
|
||||
|
||||
const activeAgentEvents = new Map();
|
||||
|
||||
/**
|
||||
* Notifies a connected agent of a new or cancelled printer job.
|
||||
* @param {number} agentId
|
||||
* @param {'created'|'cancelled'} action
|
||||
* @param {object} job
|
||||
* @returns {boolean} True if delivered to at least one active agent connection.
|
||||
*/
|
||||
export function notifyAgentJob(agentId, action, job) {
|
||||
const aId = Number(agentId);
|
||||
const conns = activeAgentEvents.get(aId);
|
||||
const count = conns ? conns.size : 0;
|
||||
log.info(`notifyAgentJob: agentId=${aId} action=${action} jobId=${job?.id} activeConnections=${count}`);
|
||||
if (!conns || conns.size === 0) {
|
||||
log.warn(`notifyAgentJob: No active SSE connection for agent ${aId} (jobId=${job?.id}); agent must poll/reconnect`);
|
||||
return false;
|
||||
}
|
||||
const payload = JSON.stringify({
|
||||
action,
|
||||
jobId: job.id,
|
||||
agentprinterId: job.agentprinterId,
|
||||
type: job.type,
|
||||
state: job.state,
|
||||
createdAt: job.createdAt,
|
||||
});
|
||||
for (const clientRes of conns) {
|
||||
if (!clientRes.writableEnded) {
|
||||
clientRes.write(`event: job\ndata: ${payload}\n\n`);
|
||||
clientRes.flush?.();
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agent/events:
|
||||
* get:
|
||||
* tags: [Agent]
|
||||
* summary: Printer agent SSE stream
|
||||
* description: |
|
||||
* Authorized Server-Sent Events stream for connected printer agents.
|
||||
* Maintains a persistent connection with regular heartbeats (`: heartbeat\n\n`) and updates `lastseen_at` and `agentversion`.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* - apiKeyAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: token
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Agent auth token if not provided via Authorization header
|
||||
* - in: query
|
||||
* name: agentversion
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Current agent version
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Event stream established
|
||||
* content:
|
||||
* text/event-stream:
|
||||
* schema:
|
||||
* type: string
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
*/
|
||||
agentRouter.get('/events', agentAuthMiddleware, async (req, res) => {
|
||||
const version = extractAgentVersion(req);
|
||||
if (version) {
|
||||
db.touchLastseen(req.agent.id, version).catch(() => { });
|
||||
}
|
||||
|
||||
res.setHeader('Content-Type', 'text/event-stream');
|
||||
res.setHeader('Cache-Control', 'no-cache');
|
||||
res.setHeader('Connection', 'keep-alive');
|
||||
res.setHeader('X-Accel-Buffering', 'no');
|
||||
res.flushHeaders?.();
|
||||
|
||||
const agentVersion = version || req.agent?.agentversion;
|
||||
const versionSuffix = agentVersion ? ` v${agentVersion}` : '';
|
||||
const agentName = req.agent?.name || 'unnamed';
|
||||
log.info(`Agent connected: id=${req.agent.id} ("${agentName}")${versionSuffix}`);
|
||||
|
||||
if (!getAgentState(req.agent.id)) {
|
||||
setAgentState(req.agent.id, 'online');
|
||||
}
|
||||
|
||||
const aId = Number(req.agent.id);
|
||||
if (!activeAgentEvents.has(aId)) {
|
||||
activeAgentEvents.set(aId, new Set());
|
||||
}
|
||||
activeAgentEvents.get(aId).add(res);
|
||||
|
||||
res.write(`event: connected\ndata: ${JSON.stringify({ agentId: req.agent.id, name: req.agent.name })}\n\n`);
|
||||
|
||||
const keepAlive = setInterval(() => {
|
||||
if (res.writableEnded) return;
|
||||
res.write(': heartbeat\n\n');
|
||||
db.touchLastseen(req.agent.id).catch(() => { });
|
||||
}, 15000);
|
||||
|
||||
let closed = false;
|
||||
const cleanup = () => {
|
||||
if (closed) return;
|
||||
closed = true;
|
||||
clearInterval(keepAlive);
|
||||
|
||||
const conns = activeAgentEvents.get(aId);
|
||||
if (conns) {
|
||||
conns.delete(res);
|
||||
if (conns.size === 0) activeAgentEvents.delete(aId);
|
||||
}
|
||||
|
||||
log.info(`Agent disconnected: id=${req.agent.id} ("${agentName}")`);
|
||||
setAgentState(req.agent.id, 'offline');
|
||||
if (req.agent?.companyId) {
|
||||
removeAgentPrinters(req.agent.companyId, req.agent.id);
|
||||
emit('printeragent', { companyId: req.agent.companyId });
|
||||
}
|
||||
};
|
||||
|
||||
req.on('close', cleanup);
|
||||
res.on('close', cleanup);
|
||||
});
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agent/state:
|
||||
* post:
|
||||
* tags: [Agent]
|
||||
* summary: Post agent state
|
||||
* description: |
|
||||
* Authorized endpoint for the printer agent to report its operational status/telemetry.
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* - apiKeyAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* state:
|
||||
* description: Status text or status object
|
||||
* responses:
|
||||
* 200:
|
||||
* description: State recorded
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* agent:
|
||||
* $ref: '#/components/schemas/Printeragent'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
*/
|
||||
async function handleState(req, res) {
|
||||
try {
|
||||
const rawState = req.body?.state;
|
||||
setAgentState(req.agent.id, rawState);
|
||||
|
||||
const version = extractAgentVersion(req);
|
||||
if (version) {
|
||||
await db.touchLastseen(req.agent.id, version);
|
||||
} else {
|
||||
await db.touchLastseen(req.agent.id);
|
||||
}
|
||||
|
||||
const rawPrinters = Array.isArray(rawState?.printers) ? rawState.printers : null;
|
||||
|
||||
let anyAgentPrinterCreated = false;
|
||||
if (rawPrinters && rawPrinters.length > 0) {
|
||||
for (const p of rawPrinters) {
|
||||
try {
|
||||
const result = await agentprinterDb.findOrCreate(req.agent.id, {
|
||||
type: p.type || 'zpl',
|
||||
model: p.model || null,
|
||||
serial: p.serial || null,
|
||||
});
|
||||
if (result?.created) {
|
||||
anyAgentPrinterCreated = true;
|
||||
}
|
||||
if (result?.agentprinter) {
|
||||
p.agentprinterId = result.agentprinter.id;
|
||||
p.enabled = result.agentprinter.enabled;
|
||||
p.sort = result.agentprinter.sort;
|
||||
}
|
||||
} catch (err) {
|
||||
log.warn(`Failed to record agentprinter for agent ${req.agent.id}:`, err);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (rawState?.job?.id && rawState?.job?.state) {
|
||||
try {
|
||||
await printerjobDb.updateState(
|
||||
{ agentId: req.agent.id },
|
||||
rawState.job.id,
|
||||
rawState.job.state
|
||||
);
|
||||
} catch (jobErr) {
|
||||
log.debug(`Agent reported job state update for ${rawState.job.id}:`, jobErr?.message);
|
||||
}
|
||||
}
|
||||
|
||||
if (rawPrinters && req.agent.companyId) {
|
||||
updateAgentPrinters(req.agent.companyId, req.agent.id, req.agent.name, rawPrinters);
|
||||
} else if (anyAgentPrinterCreated && req.agent.companyId) {
|
||||
emit('agentprinter', { companyId: req.agent.companyId });
|
||||
}
|
||||
|
||||
if (req.agent.companyId) {
|
||||
emit('printeragent', { companyId: req.agent.companyId });
|
||||
}
|
||||
|
||||
const agent = enrichAgentWithState({
|
||||
...req.agent,
|
||||
agentversion: version || req.agent.agentversion,
|
||||
lastseenAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
return res.status(200).json({
|
||||
success: true,
|
||||
agent,
|
||||
});
|
||||
} catch (err) {
|
||||
log.error('Agent post state failed:', err);
|
||||
return res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
}
|
||||
|
||||
agentRouter.post('/state', agentAuthMiddleware, handleState);
|
||||
agentRouter.put('/state', agentAuthMiddleware, handleState);
|
||||
agentRouter.get('/state', agentAuthMiddleware, (req, res) => {
|
||||
const memoryState = getAgentState(req.agent.id);
|
||||
const companyPrinters = req.agent.companyId ? getCompanyPrinters(req.agent.companyId) : [];
|
||||
const agentPrinters = companyPrinters.filter((p) => p.agentId === req.agent.id);
|
||||
res.status(200).json({
|
||||
state: memoryState ?? null,
|
||||
printers: agentPrinters,
|
||||
});
|
||||
});
|
||||
|
||||
// #region Agent Jobs
|
||||
|
||||
agentRouter.get('/jobs', agentAuthMiddleware, async (req, res) => {
|
||||
try {
|
||||
const jobs = await printerjobDb.list({ agentId: req.agent.id }, req.query);
|
||||
res.status(200).json({ jobs });
|
||||
} catch (err) {
|
||||
log.error('Agent get jobs failed:', err);
|
||||
res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
});
|
||||
|
||||
agentRouter.get('/jobs/:id', agentAuthMiddleware, async (req, res) => {
|
||||
try {
|
||||
const job = await printerjobDb.getById({ agentId: req.agent.id }, req.params.id);
|
||||
if (!job) {
|
||||
return res.status(404).json({ error: 'Printerjob not found' });
|
||||
}
|
||||
res.status(200).json({ job });
|
||||
} catch (err) {
|
||||
log.error('Agent get job failed:', err);
|
||||
res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
});
|
||||
|
||||
agentRouter.post('/jobs/:id/processing', agentAuthMiddleware, async (req, res) => {
|
||||
try {
|
||||
const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, 'processing');
|
||||
res.status(200).json({ success: true, job });
|
||||
} catch (err) {
|
||||
if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message });
|
||||
log.error('Agent set job processing failed:', err);
|
||||
res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
});
|
||||
|
||||
agentRouter.post('/jobs/:id/completed', agentAuthMiddleware, async (req, res) => {
|
||||
try {
|
||||
const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, 'completed');
|
||||
res.status(200).json({ success: true, job });
|
||||
} catch (err) {
|
||||
if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message });
|
||||
log.error('Agent set job completed failed:', err);
|
||||
res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
});
|
||||
|
||||
agentRouter.patch('/jobs/:id', agentAuthMiddleware, async (req, res) => {
|
||||
const state = req.body?.state;
|
||||
if (!state) {
|
||||
return res.status(400).json({ error: 'state is required' });
|
||||
}
|
||||
try {
|
||||
const job = await printerjobDb.updateState({ agentId: req.agent.id }, req.params.id, state);
|
||||
res.status(200).json({ success: true, job });
|
||||
} catch (err) {
|
||||
if (err.message === 'Printerjob not found') return res.status(404).json({ error: err.message });
|
||||
if (err.message?.startsWith('Invalid printerjob state')) return res.status(400).json({ error: err.message });
|
||||
log.error('Agent patch job failed:', err);
|
||||
res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
|
||||
75
src/api/agent/stateStore.js
Normal file
75
src/api/agent/stateStore.js
Normal file
@@ -0,0 +1,75 @@
|
||||
/**
|
||||
* In-memory state store for connected printer agents.
|
||||
* Keeps transient agent telemetry out of the database.
|
||||
*/
|
||||
|
||||
/** @type {Map<number, any>} */
|
||||
const agentStates = new Map();
|
||||
|
||||
/**
|
||||
* Sets the current telemetry/state for an agent.
|
||||
* @param {number} agentId
|
||||
* @param {any} state
|
||||
*/
|
||||
export function setAgentState(agentId, state) {
|
||||
if (agentId == null) return;
|
||||
agentStates.set(Number(agentId), state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the raw in-memory state for an agent.
|
||||
* @param {number} agentId
|
||||
* @returns {any}
|
||||
*/
|
||||
export function getAgentState(agentId) {
|
||||
if (agentId == null) return undefined;
|
||||
return agentStates.get(Number(agentId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats a state value into a concise clientstate string suitable for display (e.g. 'online', 'offline').
|
||||
* @param {any} state
|
||||
* @returns {string|null}
|
||||
*/
|
||||
export function formatClientState(state) {
|
||||
if (state == null) return null;
|
||||
if (typeof state === 'string') return state;
|
||||
if (typeof state === 'object') {
|
||||
if (typeof state.status === 'string' && state.status.trim()) {
|
||||
return state.status.trim();
|
||||
}
|
||||
if (typeof state.state === 'string' && state.state.trim()) {
|
||||
return state.state.trim();
|
||||
}
|
||||
}
|
||||
return JSON.stringify(state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes in-memory state for an agent (e.g. when deleted).
|
||||
* @param {number} agentId
|
||||
*/
|
||||
export function removeAgentState(agentId) {
|
||||
if (agentId == null) return;
|
||||
agentStates.delete(Number(agentId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Enriches a printeragent object with the in-memory state.
|
||||
* @template {object} T
|
||||
* @param {T} agent
|
||||
* @returns {T}
|
||||
*/
|
||||
export function enrichAgentWithState(agent) {
|
||||
if (!agent || typeof agent !== 'object') return agent;
|
||||
const memoryState = getAgentState(agent.id);
|
||||
if (memoryState !== undefined) {
|
||||
return {
|
||||
...agent,
|
||||
state: memoryState,
|
||||
clientstate: formatClientState(memoryState),
|
||||
};
|
||||
}
|
||||
return agent;
|
||||
}
|
||||
|
||||
@@ -1,5 +1,18 @@
|
||||
import env from '../../config/env.js';
|
||||
import { getSchemaVersion } from '../../db/store.js';
|
||||
|
||||
export function respondWithAuthenticatedUser(res, status, body) {
|
||||
return res.status(status).json({ ...body, googleClientId: env.googleClientId });
|
||||
export async function respondWithAuthenticatedUser(res, status, body) {
|
||||
let schemaVersion = null;
|
||||
try {
|
||||
schemaVersion = await getSchemaVersion();
|
||||
} catch {
|
||||
// ignore if database not accessible
|
||||
}
|
||||
return res.status(status).json({
|
||||
...body,
|
||||
googleClientId: env.googleClientId,
|
||||
schemaVersion,
|
||||
vhost: env.vhost,
|
||||
vhostSettings: env.vhostSettings,
|
||||
});
|
||||
}
|
||||
|
||||
@@ -9,14 +9,16 @@ import cookieParser from 'cookie-parser';
|
||||
import { loggerMiddleware } from './middleware/logger.js';
|
||||
import env from '../config/env.js';
|
||||
import { authMiddleware } from './middleware/auth.js';
|
||||
import { ensureConnection } from '../db/store.js';
|
||||
import { ensureConnection, getSchemaVersion, closeStore } from '../db/store.js';
|
||||
import { closeAll as closeAllSse } from './sse.js';
|
||||
import { closeAllManagers } from '../services/conversationManager.js';
|
||||
import { shutdownImageCropWorkers } from '../services/imageCrop.js';
|
||||
import { shutdownImageHashWorkers } from '../services/companyImport/imageHasher.js';
|
||||
import { shutdownJavascriptSandboxWorkers } from '../services/javascriptSandbox.js';
|
||||
import { getOrCreateCert } from '../util/cert.js';
|
||||
import { createLogger } from '../util/logger.js';
|
||||
import v1Router from '../v1/index.js';
|
||||
import { agentRouter } from './agent/index.js';
|
||||
import { startBackendMonitor, stopBackendMonitor, isDevMode } from '../backendmonitor/server.js';
|
||||
import { startBackupService, stopBackupService } from '../services/backupService.js';
|
||||
import { startHealthMonitorService, stopHealthMonitorService } from '../services/healthMonitorService.js';
|
||||
@@ -28,6 +30,7 @@ const __dirname = path.dirname(__filename);
|
||||
|
||||
async function registerRoutes(app, basePath = '') {
|
||||
const routesDir = path.join(__dirname, 'routes');
|
||||
let loadedCount = 0;
|
||||
|
||||
async function registerRouteFilesRecursively(dir) {
|
||||
for (const file of fs.readdirSync(dir)) {
|
||||
@@ -40,12 +43,14 @@ async function registerRoutes(app, basePath = '') {
|
||||
const routeModule = await import(pathToFileURL(fullPath).href);
|
||||
if (routeModule.register) {
|
||||
routeModule.register(app, basePath);
|
||||
loadedCount++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await registerRouteFilesRecursively(routesDir);
|
||||
return loadedCount;
|
||||
}
|
||||
|
||||
let server;
|
||||
@@ -96,6 +101,20 @@ function corsMiddleware(req, res, next) {
|
||||
return next();
|
||||
}
|
||||
|
||||
if (req.path.startsWith('/api/agent')) {
|
||||
res.setHeader('Access-Control-Allow-Origin', origin || '*');
|
||||
const reqHeaders = req.headers['access-control-request-headers'];
|
||||
res.setHeader(
|
||||
'Access-Control-Allow-Headers',
|
||||
reqHeaders || 'Content-Type, Authorization, x-agent-token, agentversion'
|
||||
);
|
||||
res.setHeader('Access-Control-Allow-Methods', 'GET,POST,PUT,PATCH,DELETE,OPTIONS');
|
||||
if (req.method === 'OPTIONS') {
|
||||
return res.sendStatus(204);
|
||||
}
|
||||
return next();
|
||||
}
|
||||
|
||||
if (req.path.startsWith('/v1')) {
|
||||
if (origin) {
|
||||
res.setHeader('Access-Control-Allow-Origin', origin);
|
||||
@@ -140,7 +159,7 @@ export async function buildApiApp() {
|
||||
|
||||
app.use((req, res, next) => {
|
||||
// Do not attach no-store to SSE or public endpoints
|
||||
if (req.path !== '/api/events' && !req.path.startsWith('/api/public') && !req.path.startsWith('/public')) {
|
||||
if (req.path !== '/api/events' && !req.path.endsWith('/events') && !req.path.startsWith('/api/public') && !req.path.startsWith('/public')) {
|
||||
res.setHeader('Cache-Control', 'no-store');
|
||||
}
|
||||
next();
|
||||
@@ -159,8 +178,8 @@ export async function buildApiApp() {
|
||||
});
|
||||
}
|
||||
|
||||
await registerRoutes(app, '/api');
|
||||
app.use('/v1', v1Router);
|
||||
app.routeCount = await registerRoutes(app, '/api');
|
||||
app.use('/api/agent', agentRouter);
|
||||
app.use('/api/v1', v1Router);
|
||||
|
||||
app.use((_req, res) => {
|
||||
@@ -279,6 +298,7 @@ export async function stopApi() {
|
||||
// Pooled image-crop workers are live threads and must be terminated too, or the
|
||||
// process stays alive after the last request has been served.
|
||||
await shutdownImageCropWorkers();
|
||||
await shutdownImageHashWorkers();
|
||||
// Same for the pooled sandbox threads that run `javascript_execute` / applets.
|
||||
await shutdownJavascriptSandboxWorkers();
|
||||
await stopBackupService();
|
||||
@@ -302,3 +322,64 @@ export async function stopApi() {
|
||||
}
|
||||
await Promise.all(closers);
|
||||
}
|
||||
|
||||
export async function runSelfTest() {
|
||||
const start = Date.now();
|
||||
apiLog.info('Starting dashback self-test (loading modules without binding ports)...');
|
||||
|
||||
// 1. Check configuration
|
||||
apiLog.info(`Config: host=${env.host} port=${env.port} dbProvider=${env.dbProvider}`);
|
||||
|
||||
// 2. Test database & store initialization
|
||||
await ensureConnection();
|
||||
const schemaVer = await getSchemaVersion();
|
||||
apiLog.info(`Database & store: OK (provider: ${env.dbProvider}, schema v${schemaVer})`);
|
||||
|
||||
// 3. Build API app and register all route modules
|
||||
const app = await buildApiApp();
|
||||
apiLog.info(`Routes & middleware: OK (${app.routeCount || 'all'} route modules loaded)`);
|
||||
|
||||
// 4. Test key native/WASM dependencies
|
||||
try {
|
||||
const { optimizeImage } = await import('wasm-image-optimization');
|
||||
const tinyPng = Buffer.from(
|
||||
'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
|
||||
'base64'
|
||||
);
|
||||
await optimizeImage({ image: tinyPng, format: 'png' });
|
||||
apiLog.info('WASM image pipeline: OK');
|
||||
} catch (err) {
|
||||
apiLog.warn(`WASM image pipeline warning: ${err.message}`);
|
||||
}
|
||||
|
||||
// 5. Test WASM label rasterizer
|
||||
try {
|
||||
const { renderThumb } = await import('../services/labelThumb.js');
|
||||
const thumb = await renderThumb({
|
||||
width: 300,
|
||||
height: 150,
|
||||
objects: [
|
||||
{ type: 'textbox', text: 'SELFTEST', x: 10, y: 10, font: 'outfit' },
|
||||
{ type: 'barcode', format: 'EAN13', code: '4012345678901', x: 10, y: 40, scale: 2 },
|
||||
],
|
||||
});
|
||||
if (!thumb || thumb.length === 0) {
|
||||
throw new Error('Empty thumbnail rendered');
|
||||
}
|
||||
apiLog.info('WASM label rasterizer: OK');
|
||||
} catch (err) {
|
||||
apiLog.error(`WASM label rasterizer FAILED: ${err.message}`);
|
||||
throw err;
|
||||
}
|
||||
|
||||
// 6. Clean up store connection
|
||||
try {
|
||||
await closeStore();
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
|
||||
const duration = Date.now() - start;
|
||||
apiLog.info(`Self-test PASSED: All modules and routes loaded successfully in ${duration}ms (no ports bound).`);
|
||||
return true;
|
||||
}
|
||||
|
||||
63
src/api/middleware/agentAuth.js
Normal file
63
src/api/middleware/agentAuth.js
Normal file
@@ -0,0 +1,63 @@
|
||||
import * as db from '../../db/printeragent.js';
|
||||
|
||||
export function extractAgentToken(req) {
|
||||
const authHeader = req.headers.authorization;
|
||||
if (typeof authHeader === 'string' && authHeader.trim()) {
|
||||
const trimmed = authHeader.trim();
|
||||
if (/^Bearer\s+/i.test(trimmed)) {
|
||||
return trimmed.replace(/^Bearer\s+/i, '').trim();
|
||||
}
|
||||
return trimmed;
|
||||
}
|
||||
|
||||
if (typeof req.headers['x-agent-token'] === 'string' && req.headers['x-agent-token'].trim()) {
|
||||
return req.headers['x-agent-token'].trim();
|
||||
}
|
||||
|
||||
if (typeof req.query?.token === 'string' && req.query.token.trim()) {
|
||||
return req.query.token.trim();
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
export function extractAgentVersion(req) {
|
||||
const raw = req.headers['agentversion'] ||
|
||||
req.query?.agentversion ||
|
||||
req.body?.agentversion ||
|
||||
null;
|
||||
return raw ? String(raw).trim() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticates the printer agent via token and attaches `req.agent`.
|
||||
* @param {import('express').Request} req
|
||||
* @param {import('express').Response} res
|
||||
* @param {import('express').NextFunction} next
|
||||
*/
|
||||
export async function agentAuthMiddleware(req, res, next) {
|
||||
const token = extractAgentToken(req);
|
||||
if (!token) {
|
||||
return res.status(401).json({ error: 'Unauthorized' });
|
||||
}
|
||||
|
||||
try {
|
||||
const agent = await db.findByToken(token);
|
||||
if (!agent) {
|
||||
return res.status(401).json({ error: 'Unauthorized' });
|
||||
}
|
||||
|
||||
req.agent = agent;
|
||||
|
||||
const version = extractAgentVersion(req);
|
||||
db.touchLastseen(agent.id, version).catch((err) => {
|
||||
console.error('Failed to touch lastseen for printeragent:', err);
|
||||
});
|
||||
|
||||
next();
|
||||
} catch (err) {
|
||||
console.error('Agent auth error:', err);
|
||||
return res.status(500).json({ error: 'Internal server error' });
|
||||
}
|
||||
}
|
||||
|
||||
@@ -39,7 +39,15 @@ export function clearCachedUser(authId) {
|
||||
userCache.delete(authId);
|
||||
}
|
||||
|
||||
function respondWithAuthPayload(res, req, status, body) {
|
||||
export function clearCachedCompanyUsers(companyId) {
|
||||
for (const [k, v] of userCache) {
|
||||
if (v.user?.selectedCompanyId === companyId) {
|
||||
userCache.delete(k);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function respondWithAuthPayload(res, req, status, body) {
|
||||
if (req.path === '/api/auth/me') {
|
||||
return respondWithAuthenticatedUser(res, status, body);
|
||||
}
|
||||
@@ -55,6 +63,10 @@ export const authMiddleware = async (req, res, next) => {
|
||||
return next();
|
||||
}
|
||||
|
||||
if (req.path === '/api/agent' || req.path.startsWith('/api/agent/')) {
|
||||
return next();
|
||||
}
|
||||
|
||||
if (req.path.startsWith('/api/public') || req.path.startsWith('/public')) {
|
||||
return next();
|
||||
}
|
||||
@@ -77,7 +89,7 @@ export const authMiddleware = async (req, res, next) => {
|
||||
const isDocs = req.path.startsWith('/docs') || req.path.startsWith('/api/docs');
|
||||
if (!token) {
|
||||
if (isDocs || isOAuthAuthorize) return next();
|
||||
return respondWithAuthPayload(res, req, 401, { error: 'Unauthorized' });
|
||||
return await respondWithAuthPayload(res, req, 401, { error: 'Unauthorized' });
|
||||
}
|
||||
|
||||
try {
|
||||
@@ -86,7 +98,7 @@ export const authMiddleware = async (req, res, next) => {
|
||||
if (!Number.isInteger(authId) || authId <= 0) {
|
||||
if (req.cookies.token) clearTokenCookie(res);
|
||||
if (isDocs) return next();
|
||||
return respondWithAuthPayload(res, req, 401, { error: 'Invalid token' });
|
||||
return await respondWithAuthPayload(res, req, 401, { error: 'Invalid token' });
|
||||
}
|
||||
|
||||
let user = getCachedUser(authId);
|
||||
@@ -103,7 +115,7 @@ export const authMiddleware = async (req, res, next) => {
|
||||
clearCachedUser(authId);
|
||||
if (req.cookies.token) clearTokenCookie(res);
|
||||
if (isDocs) return next();
|
||||
return respondWithAuthPayload(res, req, 403, { error: 'User is no longer authorized' });
|
||||
return await respondWithAuthPayload(res, req, 403, { error: 'User is no longer authorized' });
|
||||
}
|
||||
|
||||
req.user = {
|
||||
@@ -125,7 +137,7 @@ export const authMiddleware = async (req, res, next) => {
|
||||
} catch {
|
||||
if (req.cookies.token) clearTokenCookie(res);
|
||||
if (isDocs || isOAuthAuthorize) return next();
|
||||
return respondWithAuthPayload(res, req, 401, { error: 'Invalid token' });
|
||||
return await respondWithAuthPayload(res, req, 401, { error: 'Invalid token' });
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -59,6 +59,39 @@
|
||||
* type: number
|
||||
* taxfreerate:
|
||||
* type: number
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* description: The caller's role in this company
|
||||
* CompanyUser:
|
||||
* type: object
|
||||
* required: [id, googleAuthId, email, role]
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* googleAuthId:
|
||||
* type: integer
|
||||
* email:
|
||||
* type: string
|
||||
* picture:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* AutoInvite:
|
||||
* type: object
|
||||
* required: [id, email, role, createdAt]
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* email:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* createdAt:
|
||||
* type: string
|
||||
* SuccessResponse:
|
||||
* type: object
|
||||
* required: [ok]
|
||||
@@ -673,7 +706,7 @@
|
||||
* type: integer
|
||||
* type:
|
||||
* type: string
|
||||
* description: Sequence type (e.g. entity, article, delivery)
|
||||
* description: Sequence type (sku, entity, delivery, adjustment, shipment, quote, order, return, retoure)
|
||||
* prefix:
|
||||
* type: string
|
||||
* padding:
|
||||
@@ -1693,6 +1726,19 @@
|
||||
* nullable: true
|
||||
* syncRootArticles:
|
||||
* type: boolean
|
||||
* sort:
|
||||
* type: integer
|
||||
* description: Display order (ascending)
|
||||
* default: 0
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* description: Whether terminal is active/allowed to sync
|
||||
* default: true
|
||||
* clientversion:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* readOnly: true
|
||||
* description: Client software version reported by POS terminal during pairing (read-only)
|
||||
* lastseenAt:
|
||||
* type: string
|
||||
* nullable: true
|
||||
@@ -1703,6 +1749,117 @@
|
||||
* type: array
|
||||
* items:
|
||||
* type: integer
|
||||
* Printeragent:
|
||||
* type: object
|
||||
* required: [id, name]
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* companyId:
|
||||
* type: integer
|
||||
* name:
|
||||
* type: string
|
||||
* token:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* pairingpin:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* pairedAt:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* agentversion:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* lastseenAt:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* updatedAt:
|
||||
* type: string
|
||||
* sort:
|
||||
* type: integer
|
||||
* description: Display order (ascending)
|
||||
* default: 0
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* default: true
|
||||
* Agentprinter:
|
||||
* type: object
|
||||
* required: [id, printeragentId, type, enabled, sort]
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* printeragentId:
|
||||
* type: integer
|
||||
* type:
|
||||
* type: string
|
||||
* description: Printer type ("zpl", "esc/pos", etc.)
|
||||
* model:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* serial:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* default: true
|
||||
* sort:
|
||||
* type: integer
|
||||
* description: Display order (ascending)
|
||||
* default: 0
|
||||
* open:
|
||||
* type: boolean
|
||||
* description: Whether the printer head/cover is open
|
||||
* default: false
|
||||
* pause:
|
||||
* type: boolean
|
||||
* description: Whether the printer is paused
|
||||
* default: false
|
||||
* error:
|
||||
* type: boolean
|
||||
* description: Whether the printer is in an error state
|
||||
* default: false
|
||||
* online:
|
||||
* type: boolean
|
||||
* description: Whether the printer is online and reachable
|
||||
* default: false
|
||||
* labelLength:
|
||||
* type: integer
|
||||
* nullable: true
|
||||
* description: Discovered label length in dots/pixels reported by the printer
|
||||
* default: null
|
||||
* Printerjob:
|
||||
* type: object
|
||||
* required: [id, agentprinterId, type, state, data, createdAt]
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* description: Target agent printer ID
|
||||
* printeragentId:
|
||||
* type: integer
|
||||
* nullable: true
|
||||
* description: Parent printer agent ID
|
||||
* type:
|
||||
* type: string
|
||||
* description: Job format type ("zpl", "pdf", "epos")
|
||||
* example: "zpl"
|
||||
* state:
|
||||
* type: string
|
||||
* enum: [pending, processing, completed, cancelled, failed]
|
||||
* description: Current processing state of the job
|
||||
* example: "pending"
|
||||
* data:
|
||||
* type: string
|
||||
* description: Raw job payload
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* completedAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* LabelObject:
|
||||
* type: object
|
||||
* required: [id, type, x, y]
|
||||
|
||||
@@ -43,6 +43,9 @@ export const openApiOptions = {
|
||||
{ name: 'Image', description: 'Content-addressed AVIF by fullHash' },
|
||||
{ name: 'Posterminal', description: 'Company-scoped POS terminals' },
|
||||
{ name: 'Printer', description: 'Company-scoped receipt and label printers' },
|
||||
{ name: 'Printeragent', description: 'Company-scoped printer agents (create, rename, delete)' },
|
||||
{ name: 'Agentprinter', description: 'Company-scoped agent printers (enable, sort, delete)' },
|
||||
{ name: 'Agent', description: 'Printer agent device endpoints (pairing, SSE events, state)' },
|
||||
{ name: 'Ledger', description: 'Append-only ledger transactions' },
|
||||
{ name: 'Stock', description: 'Manual stock additions and removals' },
|
||||
{ name: 'Warehouse', description: 'Company-scoped warehouses' },
|
||||
@@ -55,6 +58,7 @@ export const openApiOptions = {
|
||||
apis: [
|
||||
path.join(root, 'src/api/openapi.js'),
|
||||
path.join(root, 'src/api/routes/**/*.js'),
|
||||
path.join(root, 'src/api/agent/**/*.js'),
|
||||
path.join(root, 'src/v1/**/*.js'),
|
||||
],
|
||||
};
|
||||
|
||||
413
src/api/routes/agentprinter.js
Normal file
413
src/api/routes/agentprinter.js
Normal file
@@ -0,0 +1,413 @@
|
||||
import * as db from '../../db/agentprinter.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { enrichAgentPrinter } from '../../services/companyPrinterService.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user?.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
return { companyId };
|
||||
}
|
||||
|
||||
function parsePositiveInt(value, field) {
|
||||
const id = Number(value);
|
||||
if (!Number.isInteger(id) || id <= 0) {
|
||||
return { error: `${field} is required` };
|
||||
}
|
||||
return { id };
|
||||
}
|
||||
|
||||
function agentprinterErrorStatus(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 === 'Printeragent not found') return 404;
|
||||
if (error.message === 'Agentprinter not found') return 404;
|
||||
if (error.message === 'Invalid agentprinter') return 400;
|
||||
if (error.message === 'Invalid agentprinter order') return 400;
|
||||
return 500;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers agentprinter routes for the authenticated user's selected company.
|
||||
* @param {import('express').Application} app - Express app
|
||||
* @param {string} [basePath=''] - Optional URL prefix for all routes in this module
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /agentprinter:
|
||||
* get:
|
||||
* tags: [Agentprinter]
|
||||
* summary: List agent printers
|
||||
* description: |
|
||||
* Lists agent printers for the authenticated user's selected company,
|
||||
* optionally filtered by printer agent ID.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: printeragentId
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Optional printer agent ID filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of agent printers
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* agentprinters:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Agentprinter'
|
||||
* 400:
|
||||
* description: No company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /agentprinter
|
||||
|
||||
app.get(`${basePath}/agentprinter`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const printeragentId = req.query?.printeragentId ? Number(req.query.printeragentId) : undefined;
|
||||
const agentprinters = await db.list(req.user.id, printeragentId);
|
||||
const enriched = agentprinters.map((p) => enrichAgentPrinter(selected.companyId, p));
|
||||
res.status(200).json({ agentprinters: enriched });
|
||||
} catch (error) {
|
||||
const status = agentprinterErrorStatus(error);
|
||||
if (status === 500) console.error('List agentprinters failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agentprinter/order:
|
||||
* put:
|
||||
* tags: [Agentprinter]
|
||||
* summary: Reorder agent printers
|
||||
* description: |
|
||||
* Reorders agent printers for a specific printer agent within the selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [agentprinter]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [agentprinterIds]
|
||||
* properties:
|
||||
* printeragentId:
|
||||
* type: integer
|
||||
* description: Optional agent id. If omitted, reorders all printers in the company.
|
||||
* agentprinterIds:
|
||||
* type: array
|
||||
* items:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Applied order
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* agentprinterIds:
|
||||
* type: array
|
||||
* items:
|
||||
* type: integer
|
||||
* 400:
|
||||
* description: Invalid order or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region PUT /agentprinter/order
|
||||
|
||||
app.put(`${basePath}/agentprinter/order`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const { printeragentId, agentprinterIds } = req.body ?? {};
|
||||
|
||||
try {
|
||||
const result = await db.order(req.user.id, { printeragentId, agentprinterIds });
|
||||
emit('agentprinter', { companyId: selected.companyId });
|
||||
res.status(200).json(result);
|
||||
} catch (error) {
|
||||
const status = agentprinterErrorStatus(error);
|
||||
if (status === 500) console.error('Order agentprinters failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agentprinter/{id}:
|
||||
* get:
|
||||
* tags: [Agentprinter]
|
||||
* summary: Get agent printer
|
||||
* description: Retrieves a single agent printer by ID.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Agent printer details
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* agentprinter:
|
||||
* $ref: '#/components/schemas/Agentprinter'
|
||||
* 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'
|
||||
* 404:
|
||||
* description: Agent printer not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /agentprinter/:id
|
||||
|
||||
app.get(`${basePath}/agentprinter/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const agentprinter = await db.getById(req.user.id, parsed.id);
|
||||
if (!agentprinter) {
|
||||
return res.status(404).json({ error: 'Agentprinter not found' });
|
||||
}
|
||||
res.status(200).json({ agentprinter: enrichAgentPrinter(selected.companyId, agentprinter) });
|
||||
} catch (error) {
|
||||
const status = agentprinterErrorStatus(error);
|
||||
if (status === 500) console.error('Get agentprinter failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agentprinter/{id}:
|
||||
* patch:
|
||||
* tags: [Agentprinter]
|
||||
* summary: Update agent printer
|
||||
* description: |
|
||||
* Updates enabled and/or display order (sort) of an agent printer.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [agentprinter]
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* sort:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Updated agent printer
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* agentprinter:
|
||||
* $ref: '#/components/schemas/Agentprinter'
|
||||
* 400:
|
||||
* description: Invalid input or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Agent printer not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region PATCH /agentprinter/:id
|
||||
|
||||
app.patch(`${basePath}/agentprinter/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
const payload = { id: parsed.id };
|
||||
if (req.body?.enabled !== undefined) payload.enabled = Boolean(req.body.enabled);
|
||||
if (req.body?.sort !== undefined) {
|
||||
const sort = Number(req.body.sort);
|
||||
if (!Number.isInteger(sort)) {
|
||||
return res.status(400).json({ error: 'sort must be an integer' });
|
||||
}
|
||||
payload.sort = sort;
|
||||
}
|
||||
|
||||
if (payload.enabled === undefined && payload.sort === undefined) {
|
||||
return res.status(400).json({ error: 'At least one field (enabled, sort) is required' });
|
||||
}
|
||||
|
||||
try {
|
||||
const agentprinter = await db.update(req.user.id, payload);
|
||||
emit('agentprinter', { companyId: selected.companyId });
|
||||
res.status(200).json({ agentprinter: enrichAgentPrinter(selected.companyId, agentprinter) });
|
||||
} catch (error) {
|
||||
const status = agentprinterErrorStatus(error);
|
||||
if (status === 500) console.error('Update agentprinter failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agentprinter/{id}:
|
||||
* delete:
|
||||
* tags: [Agentprinter]
|
||||
* summary: Delete agent printer
|
||||
* description: Deletes an agent printer from the selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [agentprinter]
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 204:
|
||||
* description: Agent printer 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'
|
||||
* 404:
|
||||
* description: Agent printer not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region DELETE /agentprinter/:id
|
||||
|
||||
app.delete(`${basePath}/agentprinter/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
await db.remove(req.user.id, parsed.id);
|
||||
emit('agentprinter', { companyId: selected.companyId });
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = agentprinterErrorStatus(error);
|
||||
if (status === 500) console.error('Delete agentprinter failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
|
||||
@@ -17,11 +17,11 @@ export function register(app, basePath = '') {
|
||||
* /article/{sku}/prices:
|
||||
* put:
|
||||
* tags: [Article]
|
||||
* summary: Replace POS prices by SKU (net > gross; price=net, tax=taxRate %)
|
||||
* summary: Replace POS prices by SKU (net > gross)
|
||||
* description: |
|
||||
* Replace-all prices for the company POS customer group.
|
||||
* `net` takes precedence over `price` (legacy alias for net) and `gross`.
|
||||
* `tax` and `taxRate` both specify the tax rate percentage (e.g. 19 for 19%), not monetary tax.
|
||||
* `net` takes precedence over `gross`.
|
||||
* `taxRate` specifies the tax rate percentage (e.g. 19 for 19%), not monetary tax.
|
||||
* When `gross` is provided, net price is computed as `gross / (1 + taxRate / 100)`.
|
||||
* Prices are strictly scoped to the company's designated POS customer group (customergroupId returned on GET).
|
||||
* Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.
|
||||
@@ -50,19 +50,13 @@ export function register(app, basePath = '') {
|
||||
* properties:
|
||||
* net:
|
||||
* type: number
|
||||
* description: Net price (excl. VAT). Either `net`, `gross`, or legacy `price` is required.
|
||||
* description: Net price (excl. VAT). Either `net` or `gross` is required.
|
||||
* gross:
|
||||
* type: number
|
||||
* description: Gross price (incl. VAT). Net is computed as `gross / (1 + taxRate / 100)`.
|
||||
* price:
|
||||
* type: number
|
||||
* description: Legacy alias for `net`.
|
||||
* taxRate:
|
||||
* type: number
|
||||
* description: Tax rate percentage (e.g. 19 for 19%, 7 for 7%, 0 for 0%).
|
||||
* tax:
|
||||
* type: number
|
||||
* description: Alias for `taxRate` percentage.
|
||||
* minmultiplier:
|
||||
* type: number
|
||||
* description: Defaults to 1; must be unique per request.
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
import fs from 'fs/promises';
|
||||
import path from 'path';
|
||||
import express from 'express';
|
||||
import { renderLabel } from 'react-canvas-label-editor';
|
||||
import * as db from '../../../db/article.js';
|
||||
import * as printerDb from '../../../db/printer.js';
|
||||
import * as agentprinterDb from '../../../db/agentprinter.js';
|
||||
import * as labeltemplateDb from '../../../db/labeltemplate.js';
|
||||
import * as printerjobDb from '../../../db/printerjob.js';
|
||||
import { notifyAgentJob } from '../../agent/index.js';
|
||||
import { pngToZpl } from '../../../services/zplService.js';
|
||||
import { applyZplCopies } from '../zpljob.js';
|
||||
import {
|
||||
AVIF_BODY_LIMIT,
|
||||
emitArticleSignal,
|
||||
@@ -12,6 +14,8 @@ import {
|
||||
parseFullHash,
|
||||
articleErrorStatus,
|
||||
interpolateString,
|
||||
withMandatedOptionsPrice,
|
||||
interpolateObjects,
|
||||
} from './shared.js';
|
||||
|
||||
/**
|
||||
@@ -325,11 +329,11 @@ export function register(app, basePath = '') {
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [templateId, printerId, quantity]
|
||||
* required: [templateId, agentprinterId, quantity]
|
||||
* properties:
|
||||
* templateId:
|
||||
* type: integer
|
||||
* printerId:
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* quantity:
|
||||
* type: integer
|
||||
@@ -364,7 +368,8 @@ export function register(app, basePath = '') {
|
||||
if (skuError) return res.status(400).json({ error: skuError });
|
||||
const sku = parsedSku;
|
||||
|
||||
const { templateId, printerId, quantity } = req.body ?? {};
|
||||
const { templateId, quantity } = req.body ?? {};
|
||||
const agentprinterId = req.body?.agentprinterId ?? req.body?.printerId;
|
||||
|
||||
if (templateId === undefined || templateId === null) {
|
||||
return res.status(400).json({ error: 'templateId is required' });
|
||||
@@ -373,11 +378,11 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: 'templateId must be an integer' });
|
||||
}
|
||||
|
||||
if (printerId === undefined || printerId === null) {
|
||||
return res.status(400).json({ error: 'printerId is required' });
|
||||
if (agentprinterId === undefined || agentprinterId === null) {
|
||||
return res.status(400).json({ error: 'agentprinterId is required' });
|
||||
}
|
||||
if (typeof printerId !== 'number' || !Number.isInteger(printerId) || printerId <= 0) {
|
||||
return res.status(400).json({ error: 'printerId must be an integer' });
|
||||
if (typeof agentprinterId !== 'number' || !Number.isInteger(agentprinterId) || agentprinterId <= 0) {
|
||||
return res.status(400).json({ error: 'agentprinterId must be an integer' });
|
||||
}
|
||||
|
||||
if (quantity === undefined || quantity === null) {
|
||||
@@ -387,28 +392,24 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: 'quantity must be an integer' });
|
||||
}
|
||||
|
||||
const parsedPrinterId = { id: printerId };
|
||||
const parsedTemplateId = { id: templateId };
|
||||
const parsedQuantity = { id: quantity };
|
||||
|
||||
try {
|
||||
const printer = await printerDb.getById(req.user.id, parsedPrinterId.id);
|
||||
if (!printer || printer.company_id !== companyId) {
|
||||
const printer = await agentprinterDb.getById(req.user.id, agentprinterId);
|
||||
if (!printer) {
|
||||
return res.status(404).json({ error: 'Printer not found' });
|
||||
}
|
||||
if (printer.type !== 'zpl') {
|
||||
if (printer.type && printer.type.toLowerCase() !== 'zpl') {
|
||||
return res.status(400).json({ error: 'Printer is not a ZPL printer' });
|
||||
}
|
||||
|
||||
const template = await labeltemplateDb.getById(req.user.id, parsedTemplateId.id);
|
||||
const template = await labeltemplateDb.getById(req.user.id, templateId);
|
||||
if (!template || template.company_id !== companyId) {
|
||||
return res.status(404).json({ error: 'Label template not found' });
|
||||
}
|
||||
|
||||
|
||||
let article;
|
||||
try {
|
||||
const result = await db.getBySku(req.user.id, sku);
|
||||
article = result?.article;
|
||||
article = result?.article ? await withMandatedOptionsPrice(req.user.id, result.article) : undefined;
|
||||
} catch (err) {
|
||||
const status = articleErrorStatus(err);
|
||||
if (status === 500) console.error('Get article by sku failed for print:', err);
|
||||
@@ -418,48 +419,50 @@ export function register(app, basePath = '') {
|
||||
return res.status(404).json({ error: 'Article not found' });
|
||||
}
|
||||
|
||||
// Extract and interpolate canvas objects
|
||||
// Extract and interpolate canvas objects or raw ZPL
|
||||
const content = template.content;
|
||||
const objects = Array.isArray(content?.objects)
|
||||
? content.objects
|
||||
: Array.isArray(content)
|
||||
? content
|
||||
: [];
|
||||
let zplData;
|
||||
|
||||
const interpolatedObjects = objects.map(obj => {
|
||||
const cloned = { ...obj };
|
||||
if (typeof cloned.text === 'string') {
|
||||
cloned.text = interpolateString(cloned.text, article);
|
||||
if (typeof content === 'string' && content.includes('^XA')) {
|
||||
let interpolated = interpolateString(content, article);
|
||||
if (quantity > 1) {
|
||||
interpolated = applyZplCopies(interpolated, quantity);
|
||||
}
|
||||
if (typeof cloned.code === 'string') {
|
||||
cloned.code = interpolateString(cloned.code, article);
|
||||
}
|
||||
return cloned;
|
||||
});
|
||||
zplData = interpolated;
|
||||
} else {
|
||||
const objects = Array.isArray(content?.objects)
|
||||
? content.objects
|
||||
: Array.isArray(content)
|
||||
? content
|
||||
: [];
|
||||
|
||||
const printPayload = await renderLabel({
|
||||
width: template.width,
|
||||
height: template.height,
|
||||
objects: interpolatedObjects,
|
||||
});
|
||||
const interpolatedObjects = interpolateObjects(objects, article);
|
||||
|
||||
// Mock network dispatch
|
||||
const printDir = path.join(process.cwd(), 'print_spool', `${printer.address}_${printer.type}`);
|
||||
await fs.mkdir(printDir, { recursive: true });
|
||||
|
||||
for (let i = 0; i < parsedQuantity.id; i++) {
|
||||
const timestamp = Date.now();
|
||||
const filename = parsedQuantity.id > 1 ? `${timestamp}_${i + 1}.png` : `${timestamp}.png`;
|
||||
const filePath = path.join(printDir, filename);
|
||||
await fs.writeFile(filePath, printPayload);
|
||||
const printPayload = await renderLabel({
|
||||
width: template.width,
|
||||
height: template.height,
|
||||
objects: interpolatedObjects,
|
||||
});
|
||||
|
||||
zplData = await pngToZpl(printPayload, quantity);
|
||||
}
|
||||
|
||||
res.status(200).json({ success: true });
|
||||
const job = await printerjobDb.create(req.user.id, {
|
||||
agentprinterId: printer.id,
|
||||
type: 'zpl',
|
||||
data: zplData,
|
||||
});
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'created', job);
|
||||
}
|
||||
|
||||
return res.status(200).json({ success: true, printerjob: job });
|
||||
} catch (error) {
|
||||
console.error('Print article label failed:', error);
|
||||
res.status(500).json({ error: error.message });
|
||||
|
||||
// #endregion
|
||||
// #endregion
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { emit } from '../../sse.js';
|
||||
import * as articleDb from '../../../db/article.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -117,20 +118,111 @@ export function articleErrorStatus(error) {
|
||||
return 500;
|
||||
}
|
||||
|
||||
const CURRENCY_FORMATTER = new Intl.NumberFormat('de-DE', {
|
||||
style: 'currency',
|
||||
currency: 'EUR',
|
||||
});
|
||||
|
||||
export function formatPrice(amount) {
|
||||
if (amount == null || !Number.isFinite(Number(amount))) return '';
|
||||
return CURRENCY_FORMATTER.format(Number(amount));
|
||||
}
|
||||
|
||||
const BASEPRICE_FORMATTER = new Intl.NumberFormat('de-DE', {
|
||||
minimumFractionDigits: 2,
|
||||
maximumFractionDigits: 2,
|
||||
});
|
||||
|
||||
/** Formats the price per base unit, e.g. "€ 4,05 / L". Empty when unit data or price is missing. */
|
||||
export function formatBasePrice(grossRaw, article) {
|
||||
const unit = article?.unit;
|
||||
const unitamount = Number(article?.unitamount);
|
||||
const factor = Number(unit?.basesifactor);
|
||||
if (grossRaw == null || !unit?.basesi || !(unitamount > 0) || !(factor > 0)) return '';
|
||||
const baseAmount = unitamount * factor;
|
||||
// Price per base unit equals the price itself: nothing to add.
|
||||
if (Math.abs(baseAmount - 1) < 1e-9) return '';
|
||||
const perBase = grossRaw / baseAmount;
|
||||
const label = factor === 1 && unit.symbol ? unit.symbol : unit.basesi;
|
||||
return `€ ${BASEPRICE_FORMATTER.format(perBase)} / ${label}`;
|
||||
}
|
||||
|
||||
function grossOf(price) {
|
||||
const net = Number(price?.net);
|
||||
if (price?.net == null || !Number.isFinite(net)) return null;
|
||||
const tax = Number(price.taxRate);
|
||||
return net * (1 + (Number.isFinite(tax) ? tax : 0) / 100);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the article with `mandatedOptionsGross` set to the summed gross price
|
||||
* (price × count) of its mandated options, for label placeholders.
|
||||
*/
|
||||
export async function withMandatedOptionsPrice(userId, article) {
|
||||
const mandated = Array.isArray(article?.options) ? article.options.filter((o) => o.mandated) : [];
|
||||
if (mandated.length === 0) return article;
|
||||
let extra = 0;
|
||||
for (const opt of mandated) {
|
||||
const result = await articleDb.getBySku(userId, opt.sku);
|
||||
const gross = grossOf(result?.article?.prices?.[0]);
|
||||
if (gross != null) extra += gross * (Number(opt.count) || 1);
|
||||
}
|
||||
return { ...article, mandatedOptionsGross: extra };
|
||||
}
|
||||
|
||||
export function interpolateString(str, article) {
|
||||
if (typeof str !== 'string') return str;
|
||||
const net = article.net_price ?? article.prices?.[0]?.net;
|
||||
const taxRate = article.prices?.[0]?.taxRate ?? 0;
|
||||
const gross = net != null ? +(net * (1 + taxRate / 100)).toFixed(2) : null;
|
||||
const ean = (article.eans && article.eans.length > 0) ? article.eans[0] : '';
|
||||
const basePrice = Array.isArray(article?.prices) && article.prices.length > 0
|
||||
? article.prices[0]
|
||||
: null;
|
||||
const net = basePrice?.net != null && Number.isFinite(Number(basePrice.net))
|
||||
? Number(basePrice.net)
|
||||
: null;
|
||||
const taxRate = basePrice?.taxRate != null && Number.isFinite(Number(basePrice.taxRate))
|
||||
? Number(basePrice.taxRate)
|
||||
: 0;
|
||||
const extra = Number(article?.mandatedOptionsGross) || 0;
|
||||
const grossRaw = net != null ? net * (1 + taxRate / 100) + extra : null;
|
||||
const gross = grossRaw != null
|
||||
? Math.round((grossRaw + Number.EPSILON) * 100) / 100
|
||||
: null;
|
||||
|
||||
return str
|
||||
.replace(/\{\{(?:ARTICLE_NAME|article_name|name)\}\}/gi, article.name || '')
|
||||
.replace(/\{\{SKU\}\}/gi, article.sku || '')
|
||||
.replace(/\{\{(?:NET_PRICE|net_price)\}\}/gi, net != null ? net.toString() : '')
|
||||
.replace(/\{\{(?:GROSS_PRICE|gross_price)\}\}/gi, gross != null ? gross.toString() : '')
|
||||
.replace(/\{\{(?:PRICE|price)\}\}/gi, gross != null ? gross.toString() : (net != null ? net.toString() : ''))
|
||||
.replace(/\{\{(?:EAN|ean)\}\}/gi, ean);
|
||||
.replace(/\{\{name\}\}/gi, article?.name || '')
|
||||
.replace(/\{\{baseprice\}\}/gi, formatBasePrice(grossRaw, article))
|
||||
.replace(/\{\{price\}\}/gi, formatPrice(gross));
|
||||
}
|
||||
|
||||
export function interpolateObjects(objects, article) {
|
||||
if (!Array.isArray(objects)) return [];
|
||||
const ean = Array.isArray(article?.eans) && article.eans.length > 0 ? String(article.eans[0]).trim() : '';
|
||||
const sku = String(article?.sku ?? '').trim();
|
||||
|
||||
return objects.map((obj) => {
|
||||
const cloned = { ...obj };
|
||||
if (typeof cloned.text === 'string') {
|
||||
cloned.text = interpolateString(cloned.text, article);
|
||||
}
|
||||
if (cloned.type === 'barcode' || typeof cloned.code === 'string') {
|
||||
const rawCode = String(cloned.code ?? '').trim();
|
||||
if (rawCode === '0' || /^0+$/.test(rawCode)) {
|
||||
if (ean) {
|
||||
cloned.code = ean;
|
||||
if (ean.length === 8) {
|
||||
cloned.format = 'EAN8';
|
||||
} else if (ean.length === 12 || ean.length === 13) {
|
||||
cloned.format = 'EAN13';
|
||||
}
|
||||
} else if (sku) {
|
||||
cloned.code = sku;
|
||||
cloned.format = 'CODE128';
|
||||
}
|
||||
} else if (typeof cloned.code === 'string') {
|
||||
cloned.code = interpolateString(cloned.code, article);
|
||||
}
|
||||
}
|
||||
return cloned;
|
||||
});
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
@@ -253,7 +253,7 @@ export function register(app, basePath = '') {
|
||||
const parsed = parseSku(req.params.sku);
|
||||
if (parsed.error) return res.status(400).json({ error: parsed.error });
|
||||
|
||||
if (req.body?.sku || req.body?.childSku) {
|
||||
if (req.body?.sku) {
|
||||
return res.status(400).json({
|
||||
error: 'sku is not allowed when creating a child article; omit sku to auto-generate or use PUT to attach an existing article',
|
||||
});
|
||||
@@ -282,9 +282,7 @@ export function register(app, basePath = '') {
|
||||
const parsed = parseSku(req.params.sku);
|
||||
if (parsed.error) return res.status(400).json({ error: parsed.error });
|
||||
|
||||
const childSku = typeof req.body?.sku === 'string' && req.body.sku.trim()
|
||||
? req.body.sku.trim()
|
||||
: (typeof req.body?.childSku === 'string' && req.body.childSku.trim() ? req.body.childSku.trim() : '');
|
||||
const childSku = typeof req.body?.sku === 'string' ? req.body.sku.trim() : '';
|
||||
if (!childSku) {
|
||||
return res.status(400).json({ error: 'sku is required' });
|
||||
}
|
||||
@@ -354,7 +352,7 @@ export function register(app, basePath = '') {
|
||||
const parsedChild = parseSku(req.params.childSku);
|
||||
if (parsedChild.error) return res.status(400).json({ error: 'childSku is required' });
|
||||
|
||||
const deleteArticle = req.query.deleteArticle === 'true' || req.body?.deleteArticle === true;
|
||||
const deleteArticle = req.query.deleteArticle === 'true';
|
||||
|
||||
try {
|
||||
const result = await db.removeChild(req.user.id, parsed.sku, parsedChild.sku, {
|
||||
|
||||
@@ -141,7 +141,7 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: skuParsed.error });
|
||||
}
|
||||
|
||||
const propertiesInput = req.body?.properties ?? req.body;
|
||||
const propertiesInput = req.body?.properties;
|
||||
if (!Array.isArray(propertiesInput)) {
|
||||
return res.status(400).json({ error: 'properties array required' });
|
||||
}
|
||||
|
||||
@@ -2,6 +2,8 @@ import jwt from 'jsonwebtoken';
|
||||
import { OAuth2Client } from 'google-auth-library';
|
||||
import env from '../../../config/env.js';
|
||||
import * as db from '../../../db/googleAuth.js';
|
||||
import * as autoinviteDb from '../../../db/autoinvite.js';
|
||||
import * as companyDb from '../../../db/company.js';
|
||||
import { clearCachedUser } from '../../middleware/auth.js';
|
||||
import { downloadPicture, toPictureBuffer } from '../../../util/pictureBinary.js';
|
||||
|
||||
@@ -20,7 +22,8 @@ export function register(app, basePath = '') {
|
||||
* tags: [Auth]
|
||||
* summary: Login with Google ID token
|
||||
* description: |
|
||||
* Verifies a Google ID token, checks allowlist (or creates entry when `IMPLICIT_CREATE=true`),
|
||||
* Verifies a Google ID token, checks allowlist (or creates entry when `IMPLICIT_CREATE=true`
|
||||
* or when the email has a pending auto-invitation),
|
||||
* stores Google `sub` and profile image bytes, and sets an HTTP-only `token` cookie.
|
||||
* `user.picture` is the profile image as base64 (same as GET /auth/me).
|
||||
* security: []
|
||||
@@ -64,7 +67,7 @@ export function register(app, basePath = '') {
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Email not on allowlist
|
||||
* description: Email not on allowlist or invited
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
@@ -104,9 +107,16 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
let allowed = await db.getAllowedEmail(email);
|
||||
if (!allowed && env.implicitCreate) {
|
||||
if (!allowed && (env.implicitCreate || (await autoinviteDb.hasPendingInvite(email)))) {
|
||||
await db.addAllowedEmail(email);
|
||||
allowed = await db.getAllowedEmail(email);
|
||||
if (allowed && allowed.selectedCompanyId == null) {
|
||||
const companies = await companyDb.listCompanies(allowed.id);
|
||||
if (companies.length > 0) {
|
||||
await db.setSelectedCompany(allowed.id, companies[0].id);
|
||||
allowed = await db.getAllowedEmail(email);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!allowed) {
|
||||
console.warn(`Login rejected: email not authorized (${email})`);
|
||||
|
||||
@@ -17,7 +17,7 @@ export function register(app, basePath = '') {
|
||||
* description: |
|
||||
* Returns the authenticated user from the session cookie and the Google client ID.
|
||||
* `user.picture` is the stored profile image as a base64 string when present.
|
||||
* Unauthenticated calls still receive `googleClientId` with 401.
|
||||
* Unauthenticated calls still receive `googleClientId` and `schemaVersion` with 401.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: auth/me.md
|
||||
@@ -33,8 +33,17 @@ export function register(app, basePath = '') {
|
||||
* $ref: '#/components/schemas/User'
|
||||
* googleClientId:
|
||||
* type: string
|
||||
* schemaVersion:
|
||||
* type: integer
|
||||
* description: Current database schema version
|
||||
* vhost:
|
||||
* type: boolean
|
||||
* description: True when running in Docker (client may change feature set)
|
||||
* vhostSettings:
|
||||
* type: string
|
||||
* description: Pipelined settings string from VHOST_SETTINGS env
|
||||
* 401:
|
||||
* description: Unauthorized — still includes `googleClientId` for the frontend
|
||||
* description: Unauthorized — still includes `googleClientId` and `schemaVersion` for the frontend
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
@@ -44,12 +53,21 @@ export function register(app, basePath = '') {
|
||||
* type: string
|
||||
* googleClientId:
|
||||
* type: string
|
||||
* schemaVersion:
|
||||
* type: integer
|
||||
* description: Current database schema version
|
||||
* vhost:
|
||||
* type: boolean
|
||||
* description: True when running in Docker (client may change feature set)
|
||||
* vhostSettings:
|
||||
* type: string
|
||||
* description: Pipelined settings string from VHOST_SETTINGS env
|
||||
*/
|
||||
app.get(`${basePath}/auth/me`, async (req, res) => {
|
||||
try {
|
||||
const row = await db.getById(req.user.id);
|
||||
if (!row) {
|
||||
return respondWithAuthenticatedUser(res, 403, { error: 'User is no longer authorized' });
|
||||
return await respondWithAuthenticatedUser(res, 403, { error: 'User is no longer authorized' });
|
||||
}
|
||||
|
||||
const pictureBinary = toPictureBuffer(row.pictureBinary);
|
||||
@@ -59,10 +77,10 @@ export function register(app, basePath = '') {
|
||||
selectedCompanyId: row.selectedCompanyId,
|
||||
...(pictureBinary && { picture: pictureBinary.toString('base64') }),
|
||||
};
|
||||
respondWithAuthenticatedUser(res, 200, { user });
|
||||
await respondWithAuthenticatedUser(res, 200, { user });
|
||||
} catch (error) {
|
||||
console.error('Get current user failed:', error);
|
||||
respondWithAuthenticatedUser(res, 500, { error: 'Failed to load user' });
|
||||
await respondWithAuthenticatedUser(res, 500, { error: 'Failed to load user' });
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import * as db from '../../../db/googleAuth.js';
|
||||
import { clearCachedUser } from '../../middleware/auth.js';
|
||||
import { setUserCompany } from '../../sse.js';
|
||||
|
||||
/**
|
||||
* Registers the selected-company route (requires auth middleware).
|
||||
@@ -18,7 +17,7 @@ export function register(app, basePath = '') {
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: auth/selected-company.md
|
||||
* x-signals: [company]
|
||||
* x-signals: [user, company]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
@@ -54,6 +53,12 @@ export function register(app, basePath = '') {
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized (the user is not a member of this company)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 500:
|
||||
* description: Server error
|
||||
* content:
|
||||
@@ -78,9 +83,11 @@ export function register(app, basePath = '') {
|
||||
selectedCompanyId: updated.selectedCompanyId,
|
||||
};
|
||||
|
||||
setUserCompany(req.user.id, updated.selectedCompanyId);
|
||||
res.status(200).json({ user });
|
||||
} catch (error) {
|
||||
if (error.message === 'Not authorized') {
|
||||
return res.status(403).json({ error: error.message });
|
||||
}
|
||||
console.error('Set selected company failed:', error);
|
||||
res.status(500).json({ error: 'Failed to set selected company' });
|
||||
}
|
||||
|
||||
271
src/api/routes/autoinvite.js
Normal file
271
src/api/routes/autoinvite.js
Normal file
@@ -0,0 +1,271 @@
|
||||
import * as db from '../../db/autoinvite.js';
|
||||
import { emit } from '../sse.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user?.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
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 autoinviteErrorStatus(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 === 'Invitation not found') return 404;
|
||||
if (error.message === 'Invalid role') return 400;
|
||||
if (error.message === 'Invalid email') return 400;
|
||||
if (error.message === 'User already registered') return 409;
|
||||
if (error.message === 'Invitation already exists') return 409;
|
||||
return 500;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers auto-invitation routes. All routes require the caller to be an
|
||||
* admin of the selected company.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /autoinvite:
|
||||
* get:
|
||||
* tags: [AutoInvite]
|
||||
* summary: List auto-invitations
|
||||
* description: Lists pending auto-invitations of the selected company. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: autoinvite/list.md
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Pending invitations
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* autoinvites:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/AutoInvite'
|
||||
* 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 (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /autoinvite
|
||||
|
||||
app.get(`${basePath}/autoinvite`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const autoinvites = await db.list(req.user.id);
|
||||
res.status(200).json({ autoinvites });
|
||||
} catch (error) {
|
||||
const status = autoinviteErrorStatus(error);
|
||||
if (status === 500) console.error('List auto-invitations failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /autoinvite:
|
||||
* post:
|
||||
* tags: [AutoInvite]
|
||||
* summary: Create auto-invitation
|
||||
* description: |
|
||||
* Registers an email for automatic membership. When a user with this email registers,
|
||||
* the invitation is removed from the list and the user is added to the company with the given role.
|
||||
* Emails that are already registered are rejected (409); use `POST /companyuser` for those. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [autoinvite]
|
||||
* x-markdown: autoinvite/create.md
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [email]
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* default: user
|
||||
* example:
|
||||
* email: newhire@example.com
|
||||
* role: user
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Created invitation
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* autoinvite:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* email:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* 400:
|
||||
* description: No company selected, invalid email or invalid role
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 409:
|
||||
* description: User already registered or invitation already exists
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region POST /autoinvite
|
||||
|
||||
app.post(`${basePath}/autoinvite`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const autoinvite = await db.add(req.user.id, {
|
||||
email: req.body?.email,
|
||||
role: req.body?.role,
|
||||
});
|
||||
emit('autoinvite', { companyId: selected.companyId });
|
||||
res.status(201).json({ autoinvite });
|
||||
} catch (error) {
|
||||
const status = autoinviteErrorStatus(error);
|
||||
if (status === 500) console.error('Create auto-invitation failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /autoinvite/{id}:
|
||||
* delete:
|
||||
* tags: [AutoInvite]
|
||||
* summary: Delete auto-invitation
|
||||
* description: Deletes a pending auto-invitation of the selected company. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [autoinvite]
|
||||
* x-markdown: autoinvite/delete.md
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 204:
|
||||
* description: 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 (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Invitation not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region DELETE /autoinvite/:id
|
||||
|
||||
app.delete(`${basePath}/autoinvite/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const parsedId = parsePositiveInt(req.params.id);
|
||||
if (parsedId.error) {
|
||||
return res.status(400).json({ error: parsedId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
await db.remove(req.user.id, parsedId.id);
|
||||
emit('autoinvite', { companyId: selected.companyId });
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = autoinviteErrorStatus(error);
|
||||
if (status === 500) console.error('Delete auto-invitation failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
@@ -252,12 +252,12 @@ export function register(app, basePath = '') {
|
||||
// #region POST /backup/:id/vfs/recover
|
||||
// MARK: handles POST /backup/:id/vfs/recover to restore a VFS file from a backup
|
||||
const handleRecover = async (req, res) => {
|
||||
const filePath = req.params.path || req.body?.path || req.body?.file || req.body?.filename || req.query?.path;
|
||||
const filePath = req.body?.path;
|
||||
if (!filePath) {
|
||||
return res.status(400).json({ error: 'File path is required' });
|
||||
}
|
||||
|
||||
const requestedCompanyId = req.body?.companyId ?? req.query?.companyId;
|
||||
const requestedCompanyId = req.body?.companyId;
|
||||
const authorized = await resolveAuthorizedCompany(req, requestedCompanyId);
|
||||
if (authorized.error) {
|
||||
return res.status(authorized.status).json({ error: authorized.error });
|
||||
|
||||
@@ -324,7 +324,7 @@ export function register(app, basePath = '') {
|
||||
* get:
|
||||
* tags: [Category]
|
||||
* summary: Articles in category
|
||||
* description: Returns articles in a category the user is authorized for (omits child articles of a parent article), sorted alphabetically by name. Each article includes `childCount` (the number of its child articles) and small thumbnail fields (`smallThumbW`, `smallThumbH`, `smallThumbBinary`).
|
||||
* description: Returns articles in a category the user is authorized for, sorted alphabetically by name. By default includes child articles (variants); pass `includeChildren=false` to omit them. Each article includes `childCount` (the number of its child articles) and small thumbnail fields (`smallThumbW`, `smallThumbH`, `smallThumbBinary`).
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: category/articles.md
|
||||
@@ -335,6 +335,13 @@ export function register(app, basePath = '') {
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Category id
|
||||
* - in: query
|
||||
* name: includeChildren
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* default: true
|
||||
* description: When true (default), includes child articles (variants) alongside parent articles. Set to false to omit child articles.
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Articles list
|
||||
@@ -374,14 +381,19 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
let includeChildren = true;
|
||||
if (req.query.includeChildren !== undefined) {
|
||||
includeChildren = req.query.includeChildren !== 'false' && req.query.includeChildren !== '0';
|
||||
}
|
||||
|
||||
try {
|
||||
const allArticles = await db.getCategoryArticles(req.user.id, parsed.id);
|
||||
const articles = allArticles
|
||||
.filter((a) => a.parentArticleId == null)
|
||||
.filter((a) => includeChildren || a.parentArticleId == null)
|
||||
.map((a) => ({
|
||||
...a,
|
||||
childCount: Number(a.childCount ?? 0),
|
||||
isParent: Boolean(a.isParent ?? a.is_parent),
|
||||
isParent: Boolean(a.isParent),
|
||||
smallThumbW: a.smallThumbW ?? null,
|
||||
smallThumbH: a.smallThumbH ?? null,
|
||||
smallThumbBinary: a.smallThumbBinary ?? null,
|
||||
|
||||
@@ -153,7 +153,7 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: idParsed.error });
|
||||
}
|
||||
|
||||
const propertiesInput = req.body?.properties ?? req.body;
|
||||
const propertiesInput = req.body?.properties;
|
||||
if (!Array.isArray(propertiesInput)) {
|
||||
return res.status(400).json({ error: 'properties array required' });
|
||||
}
|
||||
|
||||
@@ -2,13 +2,17 @@ import fs from 'fs';
|
||||
import path from 'path';
|
||||
import multer from 'multer';
|
||||
import JSZip from 'jszip';
|
||||
import env from '../../config/env.js';
|
||||
import * as db from '../../db/company.js';
|
||||
import { requireCompanyAdmin } from '../../db/companyuser.js';
|
||||
import * as googleAuth from '../../db/googleAuth.js';
|
||||
import { clearCachedUser } from '../middleware/auth.js';
|
||||
import { clearDeletedCompany, emit, setUserCompany } from '../sse.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { initCompanyVfs } from '../../tools/vfs.js';
|
||||
import { createDefaultLabelTemplates } from '../../services/defaultLabelTemplates.js';
|
||||
import { executeCompanyImport } from '../../services/companyImport.js';
|
||||
import { executeCompanyExport } from '../../services/companyExport.js';
|
||||
import { clearCompanyPrinters } from '../../services/companyPrinterService.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -85,7 +89,7 @@ function companyErrorStatus(error) {
|
||||
if (error.message === 'Company not found') return 404;
|
||||
if (error.message === 'Company name not available') return 409;
|
||||
if (error.message === 'Invalid tax rate' || error.message === 'Text required' || error.message === 'No company selected') return 400;
|
||||
if (error.message === 'Not authorized') return 403;
|
||||
if (error.message === 'Not authorized' || error.message === 'Invited users cannot create a company') return 403;
|
||||
return 500;
|
||||
}
|
||||
|
||||
@@ -138,7 +142,7 @@ export function register(app, basePath = '') {
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: company/create.md
|
||||
* x-signals: [company]
|
||||
* x-signals: [user, company]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
@@ -184,6 +188,12 @@ export function register(app, basePath = '') {
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized (invited users cannot create companies when implicit create is disabled)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /company
|
||||
|
||||
@@ -207,6 +217,13 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: body.error });
|
||||
}
|
||||
|
||||
if (!env.implicitCreate) {
|
||||
const isInvited = await db.isInvitedUser(req.user.id);
|
||||
if (isInvited) {
|
||||
return res.status(403).json({ error: 'Invited users cannot create a company' });
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const company = await db.createCompany(req.user.id, body);
|
||||
await googleAuth.setSelectedCompany(req.user.id, company.id);
|
||||
@@ -216,8 +233,12 @@ export function register(app, basePath = '') {
|
||||
} catch (vfsErr) {
|
||||
console.error('Failed to initialize company VFS:', vfsErr);
|
||||
}
|
||||
try {
|
||||
await createDefaultLabelTemplates(req.user.id);
|
||||
} catch (tplErr) {
|
||||
console.error('Failed to create default label templates:', tplErr);
|
||||
}
|
||||
const authRow = await googleAuth.getAllowedEmail(req.user.email);
|
||||
setUserCompany(req.user.id, authRow.selectedCompanyId);
|
||||
res.status(201).json({ company, user: userPayload(authRow) });
|
||||
} catch (error) {
|
||||
const status = companyErrorStatus(error);
|
||||
@@ -467,16 +488,37 @@ export function register(app, basePath = '') {
|
||||
// #region POST /company/import
|
||||
|
||||
const activeImportsByCompany = new Set();
|
||||
/** Signals for data the catalog import may create/modify (emitted even after a failed, partially applied run). */
|
||||
const IMPORT_SIGNALS = ['category', 'articles', 'brand', 'attributename', 'warehouse', 'carrier', 'supplier', 'order', 'shipment', 'stock', 'ledger'];
|
||||
const emitImportSignals = (companyId) => {
|
||||
for (const signal of IMPORT_SIGNALS) {
|
||||
emit(signal, signal === 'brand'
|
||||
? { companyId, data: { sender: '', brandId: null } }
|
||||
: { companyId });
|
||||
}
|
||||
};
|
||||
|
||||
app.post(
|
||||
`${basePath}/company/import`,
|
||||
async (req, res, next) => {
|
||||
try {
|
||||
const companyId = requireSelectedCompany(req);
|
||||
await requireCompanyAdmin(req.user.id, companyId);
|
||||
next();
|
||||
} catch (error) {
|
||||
const status = companyErrorStatus(error);
|
||||
return res.status(status).json({ error: error.message });
|
||||
}
|
||||
},
|
||||
uploadCompanyImportFile,
|
||||
async (req, res) => {
|
||||
let companyId;
|
||||
try {
|
||||
companyId = requireSelectedCompany(req);
|
||||
await requireCompanyAdmin(req.user.id, companyId);
|
||||
} catch (error) {
|
||||
return res.status(error.statusCode || 400).json({ error: error.message });
|
||||
const status = companyErrorStatus(error);
|
||||
return res.status(status).json({ error: error.message });
|
||||
}
|
||||
|
||||
if (activeImportsByCompany.has(companyId)) {
|
||||
@@ -638,6 +680,7 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
} finally {
|
||||
activeImportsByCompany.delete(companyId);
|
||||
emitImportSignals(companyId);
|
||||
}
|
||||
}
|
||||
);
|
||||
@@ -895,7 +938,7 @@ export function register(app, basePath = '') {
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: company/delete.md
|
||||
* x-signals: [company]
|
||||
* x-signals: [user, company]
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
@@ -938,7 +981,7 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
const company = await db.updateCompany(parsedId.companyId, body);
|
||||
const company = await db.updateCompany(parsedId.companyId, body, req.user.id);
|
||||
emit('company', { companyId: parsedId.companyId, data: { companyId: parsedId.companyId } });
|
||||
res.status(200).json({ company });
|
||||
} catch (error) {
|
||||
@@ -959,10 +1002,14 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
await db.deleteCompany(parsedId.companyId);
|
||||
clearDeletedCompany(parsedId.companyId);
|
||||
await db.deleteCompany(parsedId.companyId, req.user.id);
|
||||
clearCompanyPrinters(parsedId.companyId);
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = companyErrorStatus(error);
|
||||
if (status !== 500) {
|
||||
return res.status(status).json({ error: error.message });
|
||||
}
|
||||
console.error('Delete company failed:', error);
|
||||
res.status(500).json({ error: 'Failed to delete company' });
|
||||
}
|
||||
|
||||
377
src/api/routes/companyuser.js
Normal file
377
src/api/routes/companyuser.js
Normal file
@@ -0,0 +1,377 @@
|
||||
import * as db from '../../db/companyuser.js';
|
||||
import { clearCachedUser } from '../middleware/auth.js';
|
||||
import { emit } from '../sse.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user?.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
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 companyuserErrorStatus(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 === 'Company user not found') return 404;
|
||||
if (error.message === 'User not found') return 404;
|
||||
if (error.message === 'Invalid role') return 400;
|
||||
if (error.message === 'Invalid email') return 400;
|
||||
if (error.message === 'User already in company') return 409;
|
||||
if (error.message === 'Cannot demote the last admin') return 409;
|
||||
if (error.message === 'Cannot remove the last admin') return 409;
|
||||
return 500;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers company user (membership) routes. All routes require the caller
|
||||
* to be an admin of the selected company.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /companyuser:
|
||||
* get:
|
||||
* tags: [CompanyUser]
|
||||
* summary: List company users
|
||||
* description: Lists the members of the selected company with their role. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-markdown: companyuser/list.md
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Company members
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* companyusers:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/CompanyUser'
|
||||
* 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 (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /companyuser
|
||||
|
||||
app.get(`${basePath}/companyuser`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const companyusers = await db.list(req.user.id);
|
||||
res.status(200).json({ companyusers });
|
||||
} catch (error) {
|
||||
const status = companyuserErrorStatus(error);
|
||||
if (status === 500) console.error('List company users failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /companyuser:
|
||||
* post:
|
||||
* tags: [CompanyUser]
|
||||
* summary: Add an existing user to the company
|
||||
* description: |
|
||||
* Adds an existing (registered) user, identified by email, to the selected company. Admin only.
|
||||
* The added user can then switch to this company via `PUT /auth/selected-company`.
|
||||
* For emails that are not registered yet use `POST /autoinvite`.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [companyuser]
|
||||
* x-markdown: companyuser/create.md
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [email]
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* default: user
|
||||
* example:
|
||||
* email: colleague@example.com
|
||||
* role: user
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Created company user
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* companyuser:
|
||||
* $ref: '#/components/schemas/CompanyUser'
|
||||
* 400:
|
||||
* description: No company selected, invalid email or invalid role
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 403:
|
||||
* description: Not authorized (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: No registered user with this email
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 409:
|
||||
* description: User already in company
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region POST /companyuser
|
||||
|
||||
app.post(`${basePath}/companyuser`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const companyuser = await db.addByEmail(req.user.id, {
|
||||
email: req.body?.email,
|
||||
role: req.body?.role,
|
||||
});
|
||||
emit('companyuser', { companyId: selected.companyId });
|
||||
res.status(201).json({ companyuser });
|
||||
} catch (error) {
|
||||
const status = companyuserErrorStatus(error);
|
||||
if (status === 500) console.error('Add company user failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /companyuser/{id}:
|
||||
* patch:
|
||||
* tags: [CompanyUser]
|
||||
* summary: Change a company user's role
|
||||
* description: Changes the role of a member of the selected company. The last admin cannot be demoted. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [companyuser]
|
||||
* x-markdown: companyuser/update.md
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [role]
|
||||
* properties:
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [admin, user]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Updated company user
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* companyuser:
|
||||
* $ref: '#/components/schemas/CompanyUser'
|
||||
* 400:
|
||||
* description: Invalid id, role 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 (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Company user not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 409:
|
||||
* description: Cannot demote the last admin
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region PATCH /companyuser/:id
|
||||
|
||||
app.patch(`${basePath}/companyuser/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const parsedId = parsePositiveInt(req.params.id);
|
||||
if (parsedId.error) {
|
||||
return res.status(400).json({ error: parsedId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const companyuser = await db.setRole(req.user.id, parsedId.id, req.body?.role);
|
||||
clearCachedUser(companyuser.googleAuthId);
|
||||
emit('companyuser', { companyId: selected.companyId });
|
||||
res.status(200).json({ companyuser });
|
||||
} catch (error) {
|
||||
const status = companyuserErrorStatus(error);
|
||||
if (status === 500) console.error('Update company user failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /companyuser/{id}:
|
||||
* delete:
|
||||
* tags: [CompanyUser]
|
||||
* summary: Remove a user from the company
|
||||
* description: |
|
||||
* Removes a member from the selected company. History entries stay but lose their author link;
|
||||
* if the removed user had this company selected, their selection is cleared.
|
||||
* The last admin cannot be removed. Admin only.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [companyuser]
|
||||
* x-markdown: companyuser/delete.md
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 204:
|
||||
* description: Removed
|
||||
* 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 (admin of the selected company required)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Company user not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 409:
|
||||
* description: Cannot remove the last admin
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region DELETE /companyuser/:id
|
||||
|
||||
app.delete(`${basePath}/companyuser/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const parsedId = parsePositiveInt(req.params.id);
|
||||
if (parsedId.error) {
|
||||
return res.status(400).json({ error: parsedId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const removed = await db.remove(req.user.id, parsedId.id);
|
||||
clearCachedUser(removed.googleAuthId);
|
||||
emit('companyuser', { companyId: selected.companyId });
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = companyuserErrorStatus(error);
|
||||
if (status === 500) console.error('Remove company user failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
@@ -15,8 +15,9 @@ export function register(app, basePath = '') {
|
||||
* description: |
|
||||
* Opens a Server-Sent Events stream for the authenticated user.
|
||||
* Can be opened before a company is selected (`selectedCompanyId == null`);
|
||||
* when a company is selected or changed, the stream receives a `company`
|
||||
* event (`{ companyId }`) and updates its company scope in-place.
|
||||
* when a company is selected or changed, the stream receives `user`
|
||||
* (`{ selectedCompanyId }`) and `company` (`{ companyId }`) events and
|
||||
* updates its company scope in-place.
|
||||
* Clients also receive named signals when another request successfully
|
||||
* mutates shared data for the active company (including the same
|
||||
* browser's other tabs).
|
||||
@@ -25,6 +26,7 @@ export function register(app, basePath = '') {
|
||||
*
|
||||
* ```js
|
||||
* const es = new EventSource('https://…/api/events', { withCredentials: true });
|
||||
* es.addEventListener('user', () => { refetchAuthMe(); });
|
||||
* es.addEventListener('company', () => { refetchCompany(); });
|
||||
* es.addEventListener('category', () => { refetchCategoryTree(); });
|
||||
* es.addEventListener('articles', () => { refetchArticleIndex(); });
|
||||
@@ -36,22 +38,29 @@ export function register(app, basePath = '') {
|
||||
* ## Signals
|
||||
*
|
||||
* Every SSE event uses the event name as the signal id; payloads are
|
||||
* JSON and most events send an empty object `{}`. `company` emits
|
||||
* `{ companyId }` and `brand` emits `{ sender, brandId }`.
|
||||
* JSON and most events send an empty object `{}`. `user` emits
|
||||
* `{ selectedCompanyId }`, `company` emits `{ companyId }`, and `brand`
|
||||
* emits `{ sender, brandId }`.
|
||||
*
|
||||
* | Signal | Payload | Emitted after successful |
|
||||
* |--------|---------|--------------------------|
|
||||
* | `user` | `{ selectedCompanyId }` | `PUT /auth/selected-company`, `POST /company`, `DELETE /company/{id}` |
|
||||
* | `company` | `{ companyId }` | `PUT /auth/selected-company`, `POST /company`, `PUT /company/{id}`, `DELETE /company/{id}` |
|
||||
* | `category` | `{}` | `POST /category`, `PATCH /category/{id}`, `PUT /category/order`, `DELETE /category/{id}`, `POST /category/{id}/image`, `DELETE /category/{id}/image`, `PUT /category/{id}/property` |
|
||||
* | `articles` | `{}` | `POST /article`, `PATCH /article/{sku}`, `DELETE /article/{sku}`, `PUT /article/{sku}/articles`-style list-level changes, `POST /category/{id}/article` and related article-assigning category mutations |
|
||||
* | `article-<sku>` | `{}` | `PUT /article/{sku}/weight`, `PUT /article/{sku}/prices`, `PUT /article/{sku}/eans`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/brand`, `PUT /article/{sku}/images/order`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}`, supplier/article-property mutations affecting the article |
|
||||
* | `stock` | `{}` | `POST /stock/adjust` |
|
||||
* | `stock` | `{}` | `POST /stock/adjust`, `POST /company/import` (also `category`, `articles`, `brand`, `attributename`, `warehouse`, `carrier`, `supplier`, `order`, `shipment`, `ledger`) |
|
||||
* | `ledger` | `{}` | `POST /stock/adjust` |
|
||||
* | `attributename` | `{}` | `POST /attributename`, `PUT /attributename/order`, `PATCH /attributename/{id}`, `DELETE /attributename/{id}` |
|
||||
* | `propertyname` | `{}` | `POST /propertyname`, `PUT /propertyname/order`, `PATCH /propertyname/{id}`, `DELETE /propertyname/{id}` |
|
||||
* | `labeltemplate` | `{}` | `POST /labeltemplate`, `PUT /labeltemplate/{id}`, `PATCH /labeltemplate/{id}`, `DELETE /labeltemplate/{id}` |
|
||||
* | `printer` | `{}` | `POST /printer`, `PUT /printer/{id}`, `PATCH /printer/{id}`, `DELETE /printer/{id}` |
|
||||
* | `printeragent` | `{}` | `PUT /printeragent`, `PATCH /printeragent/{id}`, `DELETE /printeragent/{id}`, printer agent connect/disconnect/state |
|
||||
* | `agentprinter` | `{ printers }` or `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, agent state updates / printer discovery |
|
||||
* | `companyuser` | `{}` | `POST /companyuser`, `PATCH /companyuser/{id}`, `DELETE /companyuser/{id}` |
|
||||
* | `autoinvite` | `{}` | `POST /autoinvite`, `DELETE /autoinvite/{id}` |
|
||||
* | `warehouse` | `{}` | `POST /warehouse`, `PUT /warehouse/{id}`, `PATCH /warehouse/{id}`, `DELETE /warehouse/{id}` |
|
||||
* | `supplier` | `{}` | `POST /supplier`, `PATCH /supplier/{id}`, `DELETE /supplier/{id}` |
|
||||
* | `vfs` | `{}` | VFS uploads and filesystem mutations such as `POST /vfs/upload`, `POST /vfs/mkdir`, `POST /vfs/rename`, `PUT /vfs/{*path}`, `DELETE /vfs/{*path}` |
|
||||
* | `modelconversation` | `{}` | `POST /modelconversation`, `DELETE /modelconversation/{id}` |
|
||||
* | `modelconversation-<id>` | `{}` | Conversation-specific updates on the same model conversation thread; the concrete ID is used in the event name |
|
||||
@@ -70,6 +79,8 @@ export function register(app, basePath = '') {
|
||||
* - cookieAuth: []
|
||||
* x-markdown: events.md
|
||||
* x-sse-events:
|
||||
* - name: user
|
||||
* payload: "{ selectedCompanyId }"
|
||||
* - name: company
|
||||
* payload: "{ companyId }"
|
||||
* - name: category
|
||||
@@ -86,12 +97,24 @@ export function register(app, basePath = '') {
|
||||
* payload: "{}"
|
||||
* - name: propertyname
|
||||
* payload: "{}"
|
||||
* - name: companyuser
|
||||
* payload: "{}"
|
||||
* - name: autoinvite
|
||||
* payload: "{}"
|
||||
* - name: labeltemplate
|
||||
* payload: "{}"
|
||||
* - name: printer
|
||||
* payload: "{}"
|
||||
* - name: printeragent
|
||||
* payload: "{}"
|
||||
* - name: agentprinter
|
||||
* payload: "{ printers } or {}"
|
||||
* - name: printerjob
|
||||
* payload: "{ job } or { jobId, state }"
|
||||
* - name: warehouse
|
||||
* payload: "{}"
|
||||
* - name: supplier
|
||||
* payload: "{}"
|
||||
* - name: vfs
|
||||
* payload: "{}"
|
||||
* - name: modelconversation
|
||||
@@ -105,13 +128,17 @@ export function register(app, basePath = '') {
|
||||
* description: |
|
||||
* SSE stream (`text/event-stream`). Each signal is an SSE event
|
||||
* whose name is the signal id. Most signals send `{}` as data;
|
||||
* `company` sends `{ "companyId": 1 }` and `brand` sends
|
||||
* `user` sends `{ "selectedCompanyId": 1 }`, `company` sends
|
||||
* `{ "companyId": 1 }`, and `brand` sends
|
||||
* `{ "sender": "<x-client-id>", "brandId": 12 }`.
|
||||
* content:
|
||||
* text/event-stream:
|
||||
* schema:
|
||||
* type: string
|
||||
* example: |
|
||||
* event: user
|
||||
* data: {"selectedCompanyId":1}
|
||||
*
|
||||
* event: company
|
||||
* data: {"companyId":1}
|
||||
*
|
||||
|
||||
@@ -1,7 +1,14 @@
|
||||
import { validateObjects } from 'react-canvas-label-editor';
|
||||
import { renderLabel, validateObjects } from 'react-canvas-label-editor';
|
||||
import * as db from '../../db/labeltemplate.js';
|
||||
import * as agentprinterDb from '../../db/agentprinter.js';
|
||||
import * as printerjobDb from '../../db/printerjob.js';
|
||||
import * as articleDb from '../../db/article.js';
|
||||
import { renderThumb } from '../../services/labelThumb.js';
|
||||
import { pngToZpl } from '../../services/zplService.js';
|
||||
import { notifyAgentJob } from '../agent/index.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { applyZplCopies } from './zpljob.js';
|
||||
import { interpolateString, interpolateObjects, withMandatedOptionsPrice } from './article/shared.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -89,10 +96,45 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
const templates = await db.list(req.user.id);
|
||||
res.status(200).json({ labeltemplates: templates.map((t) => {
|
||||
const { content, ...rest } = serializeTemplate(t);
|
||||
return rest;
|
||||
}) });
|
||||
|
||||
let article = null;
|
||||
if (req.query?.sku) {
|
||||
const skuStr = String(req.query.sku).trim();
|
||||
const result = await articleDb.getBySku(req.user.id, skuStr);
|
||||
if (result?.article) {
|
||||
article = await withMandatedOptionsPrice(req.user.id, result.article);
|
||||
}
|
||||
}
|
||||
|
||||
const labeltemplates = await Promise.all(
|
||||
templates.map(async (t) => {
|
||||
const { content, ...rest } = serializeTemplate(t);
|
||||
if (article) {
|
||||
try {
|
||||
const full = await db.getById(req.user.id, t.id);
|
||||
const objects = Array.isArray(full?.content?.objects)
|
||||
? full.content.objects
|
||||
: Array.isArray(full?.content)
|
||||
? full.content
|
||||
: null;
|
||||
if (objects && objects.length > 0) {
|
||||
const interpolated = interpolateObjects(objects, article);
|
||||
const thumbBuffer = await renderThumb({
|
||||
width: t.width,
|
||||
height: t.height,
|
||||
objects: interpolated,
|
||||
});
|
||||
rest.thumb = thumbBuffer.toString('base64');
|
||||
}
|
||||
} catch (err) {
|
||||
console.error(`Failed to render preview thumb for template ${t.id} with sku ${req.query.sku}:`, err);
|
||||
}
|
||||
}
|
||||
return rest;
|
||||
})
|
||||
);
|
||||
|
||||
res.status(200).json({ labeltemplates });
|
||||
} catch (error) {
|
||||
const status = labeltemplateErrorStatus(error);
|
||||
if (status === 500) console.error('List label templates failed:', error);
|
||||
@@ -166,7 +208,32 @@ export function register(app, basePath = '') {
|
||||
if (!template) {
|
||||
return res.status(404).json({ error: 'Label template not found' });
|
||||
}
|
||||
res.status(200).json({ labeltemplate: serializeTemplate(template) });
|
||||
const serialized = serializeTemplate(template);
|
||||
if (req.query?.sku) {
|
||||
const skuStr = String(req.query.sku).trim();
|
||||
const result = await articleDb.getBySku(req.user.id, skuStr);
|
||||
if (result?.article) {
|
||||
const objects = Array.isArray(serialized?.content?.objects)
|
||||
? serialized.content.objects
|
||||
: Array.isArray(serialized?.content)
|
||||
? serialized.content
|
||||
: null;
|
||||
if (objects && objects.length > 0) {
|
||||
try {
|
||||
const interpolated = interpolateObjects(objects, await withMandatedOptionsPrice(req.user.id, result.article));
|
||||
const thumbBuffer = await renderThumb({
|
||||
width: template.width,
|
||||
height: template.height,
|
||||
objects: interpolated,
|
||||
});
|
||||
serialized.thumb = thumbBuffer.toString('base64');
|
||||
} catch (err) {
|
||||
console.error(`Failed to render preview thumb for template ${template.id} with sku ${req.query.sku}:`, err);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
res.status(200).json({ labeltemplate: serialized });
|
||||
} catch (error) {
|
||||
const status = labeltemplateErrorStatus(error);
|
||||
if (status === 500) console.error('Get label template failed:', error);
|
||||
@@ -482,6 +549,173 @@ export function register(app, basePath = '') {
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /labeltemplate/testprint:
|
||||
* post:
|
||||
* tags: [LabelTemplate]
|
||||
* summary: Test print label template
|
||||
* description: |
|
||||
* Dispatches a test print job for a label template or unsaved canvas objects to a specified ZPL printer.
|
||||
* Placeholders in text and barcodes are interpolated using a sample article or the specified article SKU.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [agentprinterId]
|
||||
* properties:
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* description: Agent printer ID
|
||||
* templateId:
|
||||
* type: integer
|
||||
* objects:
|
||||
* type: array
|
||||
* width:
|
||||
* type: integer
|
||||
* height:
|
||||
* type: integer
|
||||
* dpi:
|
||||
* type: integer
|
||||
* sku:
|
||||
* type: string
|
||||
* quantity:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Print job created
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* 400:
|
||||
* description: Invalid parameters
|
||||
* 404:
|
||||
* description: Printer or template not found
|
||||
* 500:
|
||||
* description: Server error
|
||||
*/
|
||||
// #region POST /labeltemplate/testprint
|
||||
|
||||
async function handleTestPrint(req, res) {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const companyId = selected.companyId;
|
||||
|
||||
const parsedPrinterId = parsePositiveInt(req.body?.agentprinterId, 'agentprinterId');
|
||||
if (parsedPrinterId.error) {
|
||||
return res.status(400).json({ error: parsedPrinterId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const printer = await agentprinterDb.getById(req.user.id, parsedPrinterId.id);
|
||||
if (!printer) {
|
||||
return res.status(404).json({ error: 'Printer not found' });
|
||||
}
|
||||
|
||||
if (printer.type && printer.type.toLowerCase() !== 'zpl') {
|
||||
return res.status(400).json({ error: 'Printer is not a ZPL printer' });
|
||||
}
|
||||
|
||||
const rawTemplateId = req.params?.id ?? req.body?.templateId;
|
||||
let template = null;
|
||||
if (rawTemplateId != null) {
|
||||
const parsedTmplId = parsePositiveInt(rawTemplateId, 'templateId');
|
||||
if (!parsedTmplId.error) {
|
||||
template = await db.getById(req.user.id, parsedTmplId.id);
|
||||
if (!template || template.company_id !== companyId) {
|
||||
return res.status(404).json({ error: 'Label template not found' });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const rawQuantity = req.body?.quantity ?? 1;
|
||||
const quantity = Number(rawQuantity) > 0 ? Number(rawQuantity) : 1;
|
||||
|
||||
let objects = req.body?.objects;
|
||||
let width = req.body?.width != null ? Number(req.body.width) : template?.width;
|
||||
let height = req.body?.height != null ? Number(req.body.height) : template?.height;
|
||||
let content = req.body?.content ?? template?.content;
|
||||
|
||||
// Resolve sample article for placeholder interpolation
|
||||
let article = null;
|
||||
if (req.body?.sku) {
|
||||
const skuStr = String(req.body.sku).trim();
|
||||
const result = await articleDb.getBySku(req.user.id, skuStr);
|
||||
if (!result?.article) {
|
||||
return res.status(404).json({ error: 'Article not found' });
|
||||
}
|
||||
article = await withMandatedOptionsPrice(req.user.id, result.article);
|
||||
} else {
|
||||
article = {
|
||||
name: template?.name || 'Musterartikel',
|
||||
sku: 'TEST-12345',
|
||||
prices: [{ net: 19.99, taxRate: 19 }],
|
||||
eans: ['4012345678901'],
|
||||
};
|
||||
}
|
||||
|
||||
let zplData;
|
||||
if (typeof content === 'string' && content.includes('^XA')) {
|
||||
let interpolated = interpolateString(content, article);
|
||||
if (quantity > 1) {
|
||||
interpolated = applyZplCopies(interpolated, quantity);
|
||||
}
|
||||
zplData = interpolated;
|
||||
} else {
|
||||
if (!objects && content) {
|
||||
objects = Array.isArray(content?.objects)
|
||||
? content.objects
|
||||
: Array.isArray(content)
|
||||
? content
|
||||
: [];
|
||||
}
|
||||
if (!Array.isArray(objects)) {
|
||||
objects = [];
|
||||
}
|
||||
|
||||
const interpolatedObjects = interpolateObjects(objects, article);
|
||||
|
||||
const printPayload = await renderLabel({
|
||||
width: width || 448,
|
||||
height: height || 200,
|
||||
objects: interpolatedObjects,
|
||||
});
|
||||
|
||||
zplData = await pngToZpl(printPayload, quantity);
|
||||
}
|
||||
|
||||
const job = await printerjobDb.create(req.user.id, {
|
||||
agentprinterId: printer.id,
|
||||
type: 'zpl',
|
||||
data: zplData,
|
||||
});
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'created', job);
|
||||
}
|
||||
|
||||
return res.status(200).json({ success: true, printerjob: job });
|
||||
} catch (error) {
|
||||
console.error('Testprint label template failed:', error);
|
||||
return res.status(500).json({ error: error.message });
|
||||
}
|
||||
}
|
||||
|
||||
app.post(`${basePath}/labeltemplate/testprint`, handleTestPrint);
|
||||
app.post(`${basePath}/labeltemplate/:id/testprint`, handleTestPrint);
|
||||
|
||||
// #endregion
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -101,7 +101,7 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
const manifestarticleId = Number(req.params.manifestarticleId);
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
const transactionType = req.query.transaction_type;
|
||||
|
||||
try {
|
||||
const ledger = await db.listByManifestarticleId(
|
||||
@@ -186,7 +186,7 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
const sku = req.params.sku;
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
const transactionType = req.query.transaction_type;
|
||||
|
||||
try {
|
||||
const ledger = await db.listBySku(req.user.id, sku, transactionType);
|
||||
@@ -254,9 +254,9 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const rawManifestarticleId = req.query.manifestarticle_id ?? req.query.manifestarticleId;
|
||||
const rawManifestarticleId = req.query.manifestarticle_id;
|
||||
const sku = req.query.sku;
|
||||
const transactionType = req.query.transaction_type ?? req.query.transactionType;
|
||||
const transactionType = req.query.transaction_type;
|
||||
|
||||
if (rawManifestarticleId == null && (sku == null || !String(sku).trim())) {
|
||||
return res.status(400).json({
|
||||
|
||||
@@ -132,6 +132,12 @@ export function register(app, basePath = '') {
|
||||
* syncRootArticles:
|
||||
* type: boolean
|
||||
* default: true
|
||||
* sort:
|
||||
* type: integer
|
||||
* default: 0
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* default: true
|
||||
* example:
|
||||
* name: "Kassa 1"
|
||||
* responses:
|
||||
@@ -184,12 +190,13 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
const pairingpin = String(randomInt(100000, 999999));
|
||||
const rootCategoryId = req.body.rootCategoryId !== undefined
|
||||
? req.body.rootCategoryId
|
||||
: req.body.root_category_id;
|
||||
const syncRootArticles = req.body.syncRootArticles !== undefined
|
||||
? req.body.syncRootArticles
|
||||
: req.body.sync_root_articles;
|
||||
const rootCategoryId = req.body.rootCategoryId;
|
||||
const syncRootArticles = req.body.syncRootArticles;
|
||||
const sort = req.body.sort !== undefined ? Number(req.body.sort) : undefined;
|
||||
if (sort !== undefined && !Number.isInteger(sort)) {
|
||||
return res.status(400).json({ error: 'sort must be an integer' });
|
||||
}
|
||||
const enabled = req.body.enabled !== undefined ? Boolean(req.body.enabled) : undefined;
|
||||
|
||||
try {
|
||||
const posterminal = await db.upsert(req.user.id, {
|
||||
@@ -197,6 +204,8 @@ export function register(app, basePath = '') {
|
||||
pairingpin,
|
||||
rootCategoryId,
|
||||
syncRootArticles,
|
||||
sort,
|
||||
enabled,
|
||||
});
|
||||
res.status(200).json({ posterminal });
|
||||
} catch (error) {
|
||||
@@ -239,6 +248,10 @@ export function register(app, basePath = '') {
|
||||
* nullable: true
|
||||
* syncRootArticles:
|
||||
* type: boolean
|
||||
* sort:
|
||||
* type: integer
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* pairingpin:
|
||||
* type: string
|
||||
* nullable: true
|
||||
@@ -302,14 +315,24 @@ export function register(app, basePath = '') {
|
||||
payload.name = req.body.name.trim();
|
||||
}
|
||||
|
||||
if (req.body.rootCategoryId !== undefined || req.body.root_category_id !== undefined) {
|
||||
const rawCat = req.body.rootCategoryId !== undefined ? req.body.rootCategoryId : req.body.root_category_id;
|
||||
payload.rootCategoryId = rawCat != null ? Number(rawCat) : null;
|
||||
if (req.body.rootCategoryId !== undefined) {
|
||||
payload.rootCategoryId = req.body.rootCategoryId != null ? Number(req.body.rootCategoryId) : null;
|
||||
}
|
||||
|
||||
if (req.body.syncRootArticles !== undefined || req.body.sync_root_articles !== undefined) {
|
||||
const rawSync = req.body.syncRootArticles !== undefined ? req.body.syncRootArticles : req.body.sync_root_articles;
|
||||
payload.syncRootArticles = Boolean(rawSync);
|
||||
if (req.body.syncRootArticles !== undefined) {
|
||||
payload.syncRootArticles = Boolean(req.body.syncRootArticles);
|
||||
}
|
||||
|
||||
if (req.body.sort !== undefined) {
|
||||
const rawSort = Number(req.body.sort);
|
||||
if (!Number.isInteger(rawSort)) {
|
||||
return res.status(400).json({ error: 'sort must be an integer' });
|
||||
}
|
||||
payload.sort = rawSort;
|
||||
}
|
||||
|
||||
if (req.body.enabled !== undefined) {
|
||||
payload.enabled = Boolean(req.body.enabled);
|
||||
}
|
||||
|
||||
if (req.body.pairingpin !== undefined) {
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import * as db from '../../db/printer.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { getCompanyPrinters, getCompanyPrinter } from '../../services/companyPrinterService.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -90,7 +91,17 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
const printers = await db.list(req.user.id);
|
||||
res.status(200).json({ printers });
|
||||
const livePrinters = getCompanyPrinters(selected.companyId);
|
||||
const enriched = printers.map((p) => {
|
||||
const live = livePrinters.find((lp) =>
|
||||
(p.serial && lp.serial && String(p.serial).toLowerCase() === String(lp.serial).toLowerCase()) ||
|
||||
(p.address && lp.ip && String(p.address).toLowerCase() === String(lp.ip).toLowerCase()) ||
|
||||
(p.address && lp.address && String(p.address).toLowerCase() === String(lp.address).toLowerCase()) ||
|
||||
(p.name && lp.name && String(p.name).toLowerCase() === String(lp.name).toLowerCase())
|
||||
);
|
||||
return live ? { ...p, state: live } : p;
|
||||
});
|
||||
res.status(200).json({ printers: enriched });
|
||||
} catch (error) {
|
||||
const status = printerErrorStatus(error);
|
||||
if (status === 500) console.error('List printers failed:', error);
|
||||
@@ -100,6 +111,186 @@ export function register(app, basePath = '') {
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printer/state:
|
||||
* get:
|
||||
* tags: [Printer]
|
||||
* summary: Get live printer states
|
||||
* description: |
|
||||
* Retrieves real-time operational status and telemetry for all discovered printers
|
||||
* reported by active printer agents for the authenticated user's selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: serial
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Optional serial number filter
|
||||
* - in: query
|
||||
* name: agentId
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Optional agent ID filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Live printer states
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printers:
|
||||
* type: array
|
||||
* items:
|
||||
* type: object
|
||||
* 400:
|
||||
* description: No company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /printer/state
|
||||
|
||||
app.get(`${basePath}/printer/state`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
let printers = getCompanyPrinters(selected.companyId);
|
||||
|
||||
if (req.query?.serial) {
|
||||
const serialFilter = String(req.query.serial).trim().toLowerCase();
|
||||
printers = printers.filter((p) => p.serial && String(p.serial).toLowerCase() === serialFilter);
|
||||
}
|
||||
|
||||
if (req.query?.agentId) {
|
||||
const aId = Number(req.query.agentId);
|
||||
if (Number.isInteger(aId)) {
|
||||
printers = printers.filter((p) => p.agentId === aId);
|
||||
}
|
||||
}
|
||||
|
||||
res.status(200).json({ printers });
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printer/{id}/state:
|
||||
* get:
|
||||
* tags: [Printer]
|
||||
* summary: Get live state for a printer
|
||||
* description: |
|
||||
* Retrieves live operational status for a single printer by configured printer ID,
|
||||
* serial number, or device identifier for the authenticated user's selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Configured printer ID, serial number, or device identifier
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Live printer state
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printer:
|
||||
* type: object
|
||||
* 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'
|
||||
* 404:
|
||||
* description: Printer not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /printer/:id/state
|
||||
|
||||
const handlePrinterStateById = async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const identifier = req.params.id;
|
||||
if (!identifier) {
|
||||
return res.status(400).json({ error: 'id is required' });
|
||||
}
|
||||
|
||||
let livePrinter = getCompanyPrinter(selected.companyId, identifier);
|
||||
|
||||
const numericId = Number(identifier);
|
||||
if (!livePrinter && Number.isInteger(numericId) && numericId > 0) {
|
||||
try {
|
||||
const dbPrinter = await db.getById(req.user.id, numericId);
|
||||
if (dbPrinter) {
|
||||
const allLive = getCompanyPrinters(selected.companyId);
|
||||
livePrinter = allLive.find((lp) =>
|
||||
(dbPrinter.serial && lp.serial && String(dbPrinter.serial).toLowerCase() === String(lp.serial).toLowerCase()) ||
|
||||
(dbPrinter.address && lp.ip && String(dbPrinter.address).toLowerCase() === String(lp.ip).toLowerCase()) ||
|
||||
(dbPrinter.address && lp.address && String(dbPrinter.address).toLowerCase() === String(lp.address).toLowerCase()) ||
|
||||
(dbPrinter.name && lp.name && String(dbPrinter.name).toLowerCase() === String(lp.name).toLowerCase())
|
||||
) || null;
|
||||
|
||||
if (!livePrinter) {
|
||||
return res.status(200).json({
|
||||
printer: {
|
||||
id: dbPrinter.id,
|
||||
companyId: dbPrinter.company_id,
|
||||
serial: dbPrinter.serial,
|
||||
address: dbPrinter.address,
|
||||
model: dbPrinter.model,
|
||||
status: 'offline',
|
||||
online: false,
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Ignore DB error, proceed to 404
|
||||
}
|
||||
}
|
||||
|
||||
if (!livePrinter) {
|
||||
return res.status(404).json({ error: 'Printer not found' });
|
||||
}
|
||||
|
||||
res.status(200).json({ printer: livePrinter });
|
||||
};
|
||||
|
||||
app.get(`${basePath}/printer/state/:id`, handlePrinterStateById);
|
||||
app.get(`${basePath}/printer/:id/state`, handlePrinterStateById);
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printer/order:
|
||||
|
||||
390
src/api/routes/printeragent.js
Normal file
390
src/api/routes/printeragent.js
Normal file
@@ -0,0 +1,390 @@
|
||||
import { randomInt } from 'node:crypto';
|
||||
import * as db from '../../db/printeragent.js';
|
||||
import { emit } from '../sse.js';
|
||||
import { enrichAgentWithState, removeAgentState } from '../agent/stateStore.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
return { companyId };
|
||||
}
|
||||
|
||||
function parsePositiveInt(value, field) {
|
||||
const id = Number(value);
|
||||
if (!Number.isInteger(id) || id <= 0) {
|
||||
return { error: `${field} is required` };
|
||||
}
|
||||
return { id };
|
||||
}
|
||||
|
||||
function printeragentErrorStatus(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 === 'Printeragent not found') return 404;
|
||||
if (error.message === 'Invalid printeragent') return 400;
|
||||
return 500;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers printeragent routes for the authenticated user's selected company.
|
||||
* Management only (create / rename / delete); the agent's own register/operate endpoints are separate.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /printeragent:
|
||||
* get:
|
||||
* tags: [Printeragent]
|
||||
* summary: List printer agents
|
||||
* description: Lists printer agents for the authenticated user's selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Printer agent list
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printeragents:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Printeragent'
|
||||
* 400:
|
||||
* description: No company selected or 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: Company not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /printeragent
|
||||
|
||||
app.get(`${basePath}/printeragent`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const printeragents = (await db.list(req.user.id)).map(enrichAgentWithState);
|
||||
res.status(200).json({ printeragents });
|
||||
} catch (error) {
|
||||
const status = printeragentErrorStatus(error);
|
||||
if (status === 500) console.error('List printeragents failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printeragent:
|
||||
* put:
|
||||
* tags: [Printeragent]
|
||||
* summary: Create printer agent
|
||||
* description: |
|
||||
* Creates an unpaired printer agent for the selected company.
|
||||
* The pairingpin is randomly generated server-side and returned in the response.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [name]
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* sort:
|
||||
* type: integer
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* default: 0
|
||||
* example:
|
||||
* name: "Bar printer"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Created printer agent with generated pairingpin
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printeragent:
|
||||
* $ref: '#/components/schemas/Printeragent'
|
||||
* 400:
|
||||
* description: No company selected or 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: Company not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region PUT /printeragent
|
||||
|
||||
app.put(`${basePath}/printeragent`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const { name } = req.body ?? {};
|
||||
if (typeof name !== 'string' || !name.trim()) {
|
||||
return res.status(400).json({ error: 'name is required' });
|
||||
}
|
||||
|
||||
let sort;
|
||||
if (req.body?.sort !== undefined) {
|
||||
sort = Number(req.body.sort);
|
||||
if (!Number.isInteger(sort)) {
|
||||
return res.status(400).json({ error: 'sort must be an integer' });
|
||||
}
|
||||
}
|
||||
|
||||
const pairingpin = String(randomInt(100000, 999999));
|
||||
|
||||
try {
|
||||
const printeragent = await db.create(req.user.id, {
|
||||
name: name.trim(),
|
||||
pairingpin,
|
||||
sort,
|
||||
});
|
||||
emit('printeragent', { companyId: selected.companyId });
|
||||
res.status(200).json({ printeragent: enrichAgentWithState(printeragent) });
|
||||
} catch (error) {
|
||||
const status = printeragentErrorStatus(error);
|
||||
if (status === 500) console.error('Create printeragent failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printeragent/{id}:
|
||||
* patch:
|
||||
* tags: [Printeragent]
|
||||
* summary: Update printer agent
|
||||
* description: Updates name and/or display order (sort) of a printer agent.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* sort:
|
||||
* type: integer
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Updated printer agent
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printeragent:
|
||||
* $ref: '#/components/schemas/Printeragent'
|
||||
* 400:
|
||||
* description: No company selected or 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: Printeragent not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region PATCH /printeragent/:id
|
||||
|
||||
app.patch(`${basePath}/printeragent/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
const { name } = req.body ?? {};
|
||||
if (name === undefined && req.body?.sort === undefined && req.body?.enabled === undefined) {
|
||||
return res.status(400).json({ error: 'name, sort, or enabled is required' });
|
||||
}
|
||||
|
||||
if (name !== undefined && (typeof name !== 'string' || !name.trim())) {
|
||||
return res.status(400).json({ error: 'name must be a non-empty string' });
|
||||
}
|
||||
|
||||
let sort;
|
||||
if (req.body?.sort !== undefined) {
|
||||
sort = Number(req.body.sort);
|
||||
if (!Number.isInteger(sort)) {
|
||||
return res.status(400).json({ error: 'sort must be an integer' });
|
||||
}
|
||||
}
|
||||
|
||||
const payload = { id: parsed.id };
|
||||
if (name !== undefined) payload.name = name.trim();
|
||||
if (sort !== undefined) payload.sort = sort;
|
||||
if (req.body?.enabled !== undefined) payload.enabled = Boolean(req.body.enabled);
|
||||
|
||||
try {
|
||||
const printeragent = await db.update(req.user.id, payload);
|
||||
emit('printeragent', { companyId: selected.companyId });
|
||||
res.status(200).json({ printeragent: enrichAgentWithState(printeragent) });
|
||||
} catch (error) {
|
||||
const status = printeragentErrorStatus(error);
|
||||
if (status === 500) console.error('Update printeragent failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printeragent/{id}:
|
||||
* delete:
|
||||
* tags: [Printeragent]
|
||||
* summary: Delete printer agent
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* 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: Printeragent not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region DELETE /printeragent/:id
|
||||
|
||||
app.delete(`${basePath}/printeragent/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
await db.remove(req.user.id, parsed.id);
|
||||
removeAgentState(parsed.id);
|
||||
emit('printeragent', { companyId: selected.companyId });
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = printeragentErrorStatus(error);
|
||||
if (status === 500) console.error('Delete printeragent failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
455
src/api/routes/printerjob.js
Normal file
455
src/api/routes/printerjob.js
Normal file
@@ -0,0 +1,455 @@
|
||||
import * as printerjobDb from '../../db/printerjob.js';
|
||||
import { notifyAgentJob } from '../agent/index.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
function requireSelectedCompany(req) {
|
||||
const companyId = req.user?.selectedCompanyId;
|
||||
if (companyId == null) {
|
||||
return { error: 'No company selected' };
|
||||
}
|
||||
return { companyId: Number(companyId) };
|
||||
}
|
||||
|
||||
function parsePositiveInt(value, field) {
|
||||
const id = Number(value);
|
||||
if (!Number.isInteger(id) || id <= 0) {
|
||||
return { error: `${field} must be a positive integer` };
|
||||
}
|
||||
return { id };
|
||||
}
|
||||
|
||||
function printerjobErrorStatus(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 === 'Agentprinter not found') return 404;
|
||||
if (error.message === 'Printerjob not found') return 404;
|
||||
if (error.message?.includes('is required')) return 400;
|
||||
if (error.message?.startsWith('Invalid printerjob')) return 400;
|
||||
return 500;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers printerjob routes.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob:
|
||||
* get:
|
||||
* tags: [PrinterJob]
|
||||
* summary: List printer jobs
|
||||
* description: Lists printer jobs for the selected company, optionally filtered by agent printer or state.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: agentprinterId
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Optional agent printer ID filter
|
||||
* - in: query
|
||||
* name: state
|
||||
* schema:
|
||||
* type: string
|
||||
* enum: [pending, processing, completed, cancelled, failed]
|
||||
* description: Optional job state filter
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of printer jobs
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printerjobs:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
* 400:
|
||||
* description: No company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /printerjob
|
||||
|
||||
app.get(`${basePath}/printerjob`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const agentprinterId = req.query?.agentprinterId ? Number(req.query.agentprinterId) : undefined;
|
||||
const state = req.query?.state ? String(req.query.state).trim().toLowerCase() : undefined;
|
||||
const printerjobs = await printerjobDb.list(req.user.id, { agentprinterId, state });
|
||||
res.status(200).json({ printerjobs });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('List printerjobs failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob/{id}:
|
||||
* get:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Get printer job
|
||||
* description: Retrieves details of a specific printer job by ID.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Printer job details
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printerjob:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
* 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'
|
||||
* 404:
|
||||
* description: Printer job not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /printerjob/:id
|
||||
|
||||
app.get(`${basePath}/printerjob/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const printerjob = await printerjobDb.getById(req.user.id, parsed.id);
|
||||
if (!printerjob) {
|
||||
return res.status(404).json({ error: 'Printerjob not found' });
|
||||
}
|
||||
res.status(200).json({ printerjob });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Get printerjob failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob:
|
||||
* post:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Create print job
|
||||
* description: Creates a new print job for an agent printer. Notifies the agent in real time.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [agentprinterId, data]
|
||||
* properties:
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* type:
|
||||
* type: string
|
||||
* example: "zpl"
|
||||
* data:
|
||||
* type: string
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Printer job created
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printerjob:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
*/
|
||||
// #region POST /printerjob
|
||||
|
||||
app.post(`${basePath}/printerjob`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const rawApId = req.body?.agentprinterId;
|
||||
const parsedApId = parsePositiveInt(rawApId, 'agentprinterId');
|
||||
if (parsedApId.error) {
|
||||
return res.status(400).json({ error: parsedApId.error });
|
||||
}
|
||||
|
||||
const rawData = req.body?.data;
|
||||
if (!rawData || typeof rawData !== 'string' || !rawData.trim()) {
|
||||
return res.status(400).json({ error: 'data is required' });
|
||||
}
|
||||
|
||||
const type = typeof req.body?.type === 'string' && req.body.type.trim()
|
||||
? req.body.type.trim().toLowerCase()
|
||||
: undefined;
|
||||
|
||||
try {
|
||||
const job = await printerjobDb.create(req.user.id, {
|
||||
agentprinterId: parsedApId.id,
|
||||
type,
|
||||
data: rawData.trim(),
|
||||
});
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'created', job);
|
||||
}
|
||||
|
||||
res.status(201).json({ printerjob: job });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Create printerjob failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob/cancel-all:
|
||||
* post:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Cancel all pending and processing printer jobs
|
||||
* description: |
|
||||
* Cancels all queued or in-flight print jobs for the selected company, optionally filtered by agentprinterId.
|
||||
* Notifies connected agents in real time.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: All matching jobs cancelled
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* cancelledCount:
|
||||
* type: integer
|
||||
* jobs:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
*/
|
||||
// #region POST /printerjob/cancel-all
|
||||
|
||||
app.post(`${basePath}/printerjob/cancel-all`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const rawApId = req.body?.agentprinterId;
|
||||
const agentprinterId = rawApId != null ? Number(rawApId) : undefined;
|
||||
const allJobs = await printerjobDb.list(req.user.id, { agentprinterId });
|
||||
const cancellable = allJobs.filter((j) => j.state === 'pending' || j.state === 'processing');
|
||||
|
||||
const cancelledJobs = [];
|
||||
for (const j of cancellable) {
|
||||
try {
|
||||
const job = await printerjobDb.updateState(req.user.id, j.id, 'cancelled');
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'cancelled', job);
|
||||
}
|
||||
cancelledJobs.push(job);
|
||||
} catch (e) {
|
||||
console.error(`Failed to cancel printerjob #${j.id}:`, e);
|
||||
}
|
||||
}
|
||||
|
||||
res.status(200).json({
|
||||
success: true,
|
||||
cancelledCount: cancelledJobs.length,
|
||||
jobs: cancelledJobs,
|
||||
});
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Cancel all printerjobs failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob/{id}/cancel:
|
||||
* post:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Cancel printer job
|
||||
* description: Marks a print job as cancelled and notifies the connected agent in real time.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Printer job cancelled
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* printerjob:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
*/
|
||||
// #region POST /printerjob/:id/cancel
|
||||
|
||||
app.post(`${basePath}/printerjob/:id/cancel`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const job = await printerjobDb.updateState(req.user.id, parsed.id, 'cancelled');
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'cancelled', job);
|
||||
}
|
||||
|
||||
res.status(200).json({ success: true, printerjob: job });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Cancel printerjob failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /printerjob/{id}:
|
||||
* delete:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Cancel and delete printer job
|
||||
* description: |
|
||||
* Cancels and deletes a print job. If the job was pending or processing, sends a cancellation
|
||||
* event to the connected printer agent before deletion.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Job cancelled and deleted
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* deletedJob:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
*/
|
||||
// #region DELETE /printerjob/:id
|
||||
|
||||
app.delete(`${basePath}/printerjob/:id`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsed = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const job = await printerjobDb.deleteJob(req.user.id, parsed.id);
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'cancelled', job);
|
||||
}
|
||||
|
||||
res.status(200).json({ success: true, deletedJob: job });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Delete printerjob failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import sharp from 'sharp';
|
||||
import { optimizeImage } from 'wasm-image-optimization';
|
||||
import * as dbCompanySetting from '../../db/companysetting.js';
|
||||
import { crawlAndProcessImage } from '../../services/imageCrop.js';
|
||||
|
||||
@@ -60,22 +60,29 @@ async function generateWebpThumbnail(img, { signal, preferSource = false } = {})
|
||||
const arrayBuffer = await response.arrayBuffer();
|
||||
const buffer = Buffer.from(arrayBuffer);
|
||||
|
||||
const thumb = await sharp(buffer)
|
||||
.rotate()
|
||||
.resize(200, 200, {
|
||||
fit: 'inside',
|
||||
withoutEnlargement: true,
|
||||
})
|
||||
.webp({ quality: 80 })
|
||||
.toBuffer({ resolveWithObject: true });
|
||||
const meta = await optimizeImage({ image: buffer, format: 'none' });
|
||||
const srcW = meta.originalWidth || 0;
|
||||
const srcH = meta.originalHeight || 0;
|
||||
const needsResize = srcW > 200 || srcH > 200;
|
||||
const scale = needsResize ? Math.min(200 / srcW, 200 / srcH) : 1;
|
||||
|
||||
const dataUrl = `data:image/webp;base64,${thumb.data.toString('base64')}`;
|
||||
const thumb = await optimizeImage({
|
||||
image: buffer,
|
||||
width: needsResize ? Math.max(1, Math.round(srcW * scale)) : undefined,
|
||||
height: needsResize ? Math.max(1, Math.round(srcH * scale)) : undefined,
|
||||
fit: 'fill',
|
||||
format: 'webp',
|
||||
quality: 80,
|
||||
});
|
||||
|
||||
const thumbBuffer = Buffer.from(thumb.data);
|
||||
const dataUrl = `data:image/webp;base64,${thumbBuffer.toString('base64')}`;
|
||||
|
||||
return {
|
||||
dataUrl,
|
||||
width: thumb.info.width,
|
||||
height: thumb.info.height,
|
||||
size: thumb.info.size,
|
||||
width: thumb.width,
|
||||
height: thumb.height,
|
||||
size: thumbBuffer.length,
|
||||
};
|
||||
} catch (err) {
|
||||
lastError = err;
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import * as db from '../../db/supplier.js';
|
||||
import { emit } from '../sse.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -114,6 +115,7 @@ export function register(app, basePath = '') {
|
||||
* Creates a supplier in the company `Lieferanten` group (created on first use).
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [supplier]
|
||||
* x-markdown: supplier/create.md
|
||||
* requestBody:
|
||||
* required: true
|
||||
@@ -194,6 +196,7 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
const supplier = await db.create(req.user.id, { name });
|
||||
emit('supplier', { companyId: selected.companyId });
|
||||
res.status(201).json({ supplier });
|
||||
} catch (error) {
|
||||
const status = supplierErrorStatus(error);
|
||||
@@ -213,6 +216,7 @@ export function register(app, basePath = '') {
|
||||
* description: Renames a supplier for the selected company.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [supplier]
|
||||
* x-markdown: supplier/update.md
|
||||
* parameters:
|
||||
* - in: path
|
||||
@@ -274,6 +278,7 @@ export function register(app, basePath = '') {
|
||||
* Related `entityhistory` cascades; `manifest.entity_id` is set null.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [supplier]
|
||||
* x-markdown: supplier/delete.md
|
||||
* parameters:
|
||||
* - in: path
|
||||
@@ -332,6 +337,7 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
const supplier = await db.update(req.user.id, id, { name });
|
||||
emit('supplier', { companyId: selected.companyId });
|
||||
res.status(200).json({ supplier });
|
||||
} catch (error) {
|
||||
const status = supplierErrorStatus(error);
|
||||
@@ -357,6 +363,7 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
await db.remove(req.user.id, id);
|
||||
emit('supplier', { companyId: selected.companyId });
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
const status = supplierErrorStatus(error);
|
||||
@@ -510,7 +517,7 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: idParsed.error });
|
||||
}
|
||||
|
||||
const skus = parseSkus(req.query.skus ?? req.query.sku);
|
||||
const skus = parseSkus(req.query.skus);
|
||||
|
||||
try {
|
||||
const articles = await db.listArticlesBySkus(req.user.id, idParsed.id, skus);
|
||||
@@ -533,7 +540,7 @@ export function register(app, basePath = '') {
|
||||
return res.status(400).json({ error: idParsed.error });
|
||||
}
|
||||
|
||||
const skus = parseSkus(req.body?.skus ?? req.body?.sku);
|
||||
const skus = parseSkus(req.body?.skus);
|
||||
|
||||
try {
|
||||
const articles = await db.listArticlesBySkus(req.user.id, idParsed.id, skus);
|
||||
|
||||
@@ -2,15 +2,18 @@ import fs from 'fs';
|
||||
import path from 'path';
|
||||
import multer from 'multer';
|
||||
import { emit } from '../sse.js';
|
||||
import { requireCompanyAdmin } from '../../db/companyuser.js';
|
||||
import {
|
||||
prepareVfs,
|
||||
resolveVfsRoot,
|
||||
isReadOnlyDatabasePath,
|
||||
isProtectedAdminVfsPath,
|
||||
directoryContainsProtectedAdminVfsFile,
|
||||
getMimeType,
|
||||
restoreDefaultSkills,
|
||||
restoreDefaultApplets,
|
||||
} from '../../tools/vfs.js';
|
||||
import sharp from 'sharp';
|
||||
import { optimizeImage } from 'wasm-image-optimization';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -286,74 +289,79 @@ function buildMetaOverlay({ width, height, size, mime, filename }, outWidth, out
|
||||
* @returns {Promise<{ buffer: Buffer, contentType: string } | null>} null when not rasterisable
|
||||
*/
|
||||
async function renderThumbnail(buffer, { mime, filename }) {
|
||||
const pipeline = sharp(buffer, { animated: false, failOn: 'none' });
|
||||
let meta;
|
||||
try {
|
||||
meta = await pipeline.metadata();
|
||||
meta = await optimizeImage({ image: buffer, format: 'none' });
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
if (!meta?.width || !meta?.height) return null;
|
||||
const origW = meta?.originalWidth;
|
||||
const origH = meta?.originalHeight;
|
||||
if (!origW || !origH) return null;
|
||||
|
||||
let scaled = await pipeline
|
||||
.resize({
|
||||
width: THUMB_BOX,
|
||||
height: THUMB_BOX,
|
||||
fit: 'inside',
|
||||
// Downscale only. Upscaling is handled explicitly below, so a 60x40 image ends up at
|
||||
// 100px (the THUMB_MIN_EDGE rule) rather than being blown up to fill the 250 box.
|
||||
withoutEnlargement: true,
|
||||
})
|
||||
.png()
|
||||
.toBuffer();
|
||||
// Downscale to fit inside THUMB_BOX without enlargement, then explicitly upscale
|
||||
// anything whose larger edge is still under THUMB_MIN_EDGE.
|
||||
const downScale = Math.min(1, THUMB_BOX / origW, THUMB_BOX / origH);
|
||||
let outWidth = Math.max(1, Math.round(origW * downScale));
|
||||
let outHeight = Math.max(1, Math.round(origH * downScale));
|
||||
|
||||
let scaledMeta = await sharp(scaled).metadata();
|
||||
|
||||
// Upscale small images so they do not render as an unreadable speck.
|
||||
const largerEdge = Math.max(scaledMeta.width, scaledMeta.height);
|
||||
const largerEdge = Math.max(outWidth, outHeight);
|
||||
if (largerEdge < THUMB_MIN_EDGE) {
|
||||
const factor = THUMB_MIN_EDGE / largerEdge;
|
||||
scaled = await sharp(scaled)
|
||||
.resize({
|
||||
width: Math.max(1, Math.round(scaledMeta.width * factor)),
|
||||
height: Math.max(1, Math.round(scaledMeta.height * factor)),
|
||||
fit: 'fill',
|
||||
})
|
||||
.png()
|
||||
.toBuffer();
|
||||
scaledMeta = await sharp(scaled).metadata();
|
||||
outWidth = Math.max(1, Math.round(outWidth * factor));
|
||||
outHeight = Math.max(1, Math.round(outHeight * factor));
|
||||
}
|
||||
|
||||
const outWidth = scaledMeta.width;
|
||||
const outHeight = scaledMeta.height;
|
||||
|
||||
const overlay = buildMetaOverlay(
|
||||
{
|
||||
width: meta.width,
|
||||
height: meta.height,
|
||||
size: buffer.length,
|
||||
mime,
|
||||
filename,
|
||||
},
|
||||
outWidth,
|
||||
{
|
||||
width: origW,
|
||||
height: origH,
|
||||
size: buffer.length,
|
||||
mime,
|
||||
filename,
|
||||
},
|
||||
outWidth,
|
||||
outHeight
|
||||
);
|
||||
|
||||
// `null` means the thumbnail is too small to carry a legible metadata band (e.g. an extreme
|
||||
// aspect ratio collapsing to a few pixels tall). Serve the plain scaled image instead.
|
||||
if (!overlay) {
|
||||
return {
|
||||
buffer: await sharp(scaled)[THUMB_FORMAT]({ quality: THUMB_QUALITY }).toBuffer(),
|
||||
contentType: `image/${THUMB_FORMAT}`,
|
||||
};
|
||||
const plain = await optimizeImage({
|
||||
image: buffer,
|
||||
width: outWidth,
|
||||
height: outHeight,
|
||||
fit: 'fill',
|
||||
format: THUMB_FORMAT,
|
||||
quality: THUMB_QUALITY,
|
||||
});
|
||||
return {
|
||||
buffer: Buffer.from(plain.data),
|
||||
contentType: `image/${THUMB_FORMAT}`,
|
||||
};
|
||||
}
|
||||
const composite = await sharp(scaled)
|
||||
.composite([{ input: overlay, top: 0, left: 0 }])
|
||||
[THUMB_FORMAT]({ quality: THUMB_QUALITY })
|
||||
.toBuffer();
|
||||
|
||||
const scaledPng = await optimizeImage({
|
||||
image: buffer,
|
||||
width: outWidth,
|
||||
height: outHeight,
|
||||
fit: 'fill',
|
||||
format: 'png',
|
||||
});
|
||||
const b64 = Buffer.from(scaledPng.data).toString('base64');
|
||||
const overlayStr = overlay.toString('utf8');
|
||||
const compositeSvg = overlayStr.replace(
|
||||
/(<svg[^>]*>)/,
|
||||
`$1<image href="data:image/png;base64,${b64}" x="0" y="0" width="${outWidth}" height="${outHeight}"/>`
|
||||
);
|
||||
const composite = await optimizeImage({
|
||||
image: compositeSvg,
|
||||
format: THUMB_FORMAT,
|
||||
quality: THUMB_QUALITY,
|
||||
});
|
||||
|
||||
return {
|
||||
buffer: composite,
|
||||
buffer: Buffer.from(composite.data),
|
||||
contentType: `image/${THUMB_FORMAT}`,
|
||||
};
|
||||
}
|
||||
@@ -581,6 +589,8 @@ export function register(app, basePath = '') {
|
||||
: '';
|
||||
const uploaded = [];
|
||||
|
||||
const parsedEntries = [];
|
||||
let touchesProtected = false;
|
||||
for (const f of files) {
|
||||
const origName = (f.originalname || 'upload').replace(/[\0\\]/g, '/');
|
||||
const relPath = targetDir ? `${targetDir}/${origName}` : origName;
|
||||
@@ -591,6 +601,18 @@ export function register(app, basePath = '') {
|
||||
|
||||
const absPath = path.resolve(vfsRoot, parsed.name);
|
||||
if (!absPath.startsWith(vfsRoot)) continue;
|
||||
|
||||
if (isProtectedAdminVfsPath(parsed.name)) {
|
||||
touchesProtected = true;
|
||||
}
|
||||
parsedEntries.push({ f, parsed, absPath });
|
||||
}
|
||||
|
||||
if (touchesProtected) {
|
||||
await requireCompanyAdmin(req.user.id, selected.companyId);
|
||||
}
|
||||
|
||||
for (const { f, parsed, absPath } of parsedEntries) {
|
||||
fs.mkdirSync(path.dirname(absPath), { recursive: true });
|
||||
fs.writeFileSync(absPath, f.buffer);
|
||||
|
||||
@@ -680,7 +702,7 @@ export function register(app, basePath = '') {
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const raw = req.body?.path || req.body?.dir || req.body?.name;
|
||||
const raw = req.body?.path;
|
||||
const parsed = parseVfsRef(raw);
|
||||
if (parsed.error) {
|
||||
return res.status(400).json({ error: parsed.error });
|
||||
@@ -782,8 +804,8 @@ export function register(app, basePath = '') {
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
const rawOld = req.body?.oldPath || req.body?.from || req.body?.source;
|
||||
const rawNew = req.body?.newPath || req.body?.to || req.body?.target;
|
||||
const rawOld = req.body?.oldPath;
|
||||
const rawNew = req.body?.newPath;
|
||||
const parsedOld = parseVfsRef(rawOld);
|
||||
if (parsedOld.error) {
|
||||
return res.status(400).json({ error: `oldPath: ${parsedOld.error}` });
|
||||
@@ -810,6 +832,15 @@ export function register(app, basePath = '') {
|
||||
return res.status(404).json({ error: 'Source file or directory not found' });
|
||||
}
|
||||
|
||||
if (
|
||||
isProtectedAdminVfsPath(parsedOld.name) ||
|
||||
isProtectedAdminVfsPath(parsedNew.name) ||
|
||||
directoryContainsProtectedAdminVfsFile(absOld) ||
|
||||
directoryContainsProtectedAdminVfsFile(absNew)
|
||||
) {
|
||||
await requireCompanyAdmin(req.user.id, selected.companyId);
|
||||
}
|
||||
|
||||
fs.mkdirSync(path.dirname(absNew), { recursive: true });
|
||||
fs.renameSync(absOld, absNew);
|
||||
|
||||
@@ -956,6 +987,9 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
if (isProtectedAdminVfsPath(parsed.name)) {
|
||||
await requireCompanyAdmin(req.user.id, selected.companyId);
|
||||
}
|
||||
const vfsRoot = await resolveVfsRoot(req.user.id);
|
||||
const absPath = path.resolve(vfsRoot, parsed.name);
|
||||
if (!absPath.startsWith(vfsRoot)) {
|
||||
@@ -1053,6 +1087,9 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
if (isProtectedAdminVfsPath(parsed.name)) {
|
||||
await requireCompanyAdmin(req.user.id, selected.companyId);
|
||||
}
|
||||
const vfsRoot = await resolveVfsRoot(req.user.id);
|
||||
const absPath = path.resolve(vfsRoot, parsed.name);
|
||||
if (!absPath.startsWith(vfsRoot)) {
|
||||
@@ -1061,6 +1098,9 @@ export function register(app, basePath = '') {
|
||||
if (!fs.existsSync(absPath)) {
|
||||
return res.status(404).json({ error: 'File not found' });
|
||||
}
|
||||
if (directoryContainsProtectedAdminVfsFile(absPath)) {
|
||||
await requireCompanyAdmin(req.user.id, selected.companyId);
|
||||
}
|
||||
const stat = fs.statSync(absPath);
|
||||
if (stat.isDirectory()) {
|
||||
fs.rmSync(absPath, { recursive: true, force: true });
|
||||
|
||||
@@ -84,7 +84,7 @@ export function register(app, basePath = '') {
|
||||
* response also carries `columns` (name/type) and `rows` (data row count). Only declared columns are
|
||||
* emitted, in header order; missing values become empty cells. Execution runs in the same isolated worker
|
||||
* sandbox as the `javascript_execute` tool — including authenticated `fetch()` against this API,
|
||||
* `fs`/`vfs`, `sharp`, ExcelJS, PDFKit and WebCrypto globals.
|
||||
* `fs`/`vfs`, `optimizeImage`, ExcelJS, PDFKit and WebCrypto globals.
|
||||
*
|
||||
* The path is taken from the URL (like `DELETE /vfs/{*path}`); the run arguments are the JSON body.
|
||||
* Path traversal (`..`), null bytes, and backslashes are rejected with HTTP 400, as is a path that does
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user