Compare commits
4 Commits
8fece9d916
...
0480a5dcbe
| Author | SHA1 | Date | |
|---|---|---|---|
|
0480a5dcbe | ||
|
|
dd5c9646b3 | ||
|
|
5a0b603306 | ||
|
|
72d05a34d0 |
@@ -41,6 +41,11 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`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` |
|
||||
@@ -223,14 +228,21 @@ 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/_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` |
|
||||
@@ -324,6 +336,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).
|
||||
|
||||
@@ -333,6 +346,7 @@ 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` |
|
||||
@@ -347,6 +361,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A
|
||||
| `modelconversation-<id>` | `POST /modelconversation/{id}/message` |
|
||||
| `order` | `DELETE /order/{id}/file/{fileId}`, `POST /order/{id}/pdf`, `DELETE /shipment/{id}`, `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}` |
|
||||
| `printer` | `POST /printer`, `PUT /printer/order`, `DELETE /printer/{id}`, `PATCH /printer/{id}`, `PUT /printer/{id}` |
|
||||
| `printerjob` | `POST /printerjob`, `DELETE /printerjob/{id}`, `POST /printerjob/{id}/cancel`, `POST /zpljob` |
|
||||
| `propertyname` | `POST /propertyname`, `PUT /propertyname/order`, `DELETE /propertyname/{id}`, `PATCH /propertyname/{id}` |
|
||||
| `quote` | `DELETE /quote/{id}/file/{fileId}`, `POST /quote/{id}/pdf` |
|
||||
| `shipment` | `DELETE /shipment/{id}`, `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}`, `POST /shipment/{id}/pdf` |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 292 API endpoints across all modules.
|
||||
Overview of all 305 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -9,45 +9,47 @@ 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: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T21|null, shippings?: T21[], payment?: T30|null, payments?: T30[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T11[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T19[], shippings: T21[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T11[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T11[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T22[], files: T11[], externalNumber?: str|null, createdAt?: str, ledger?: T37 }`
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T20[], externalNumber?: str|null, createdAt?: str, shipping?: T23|null, shippings?: T23[], payment?: T32|null, payments?: T32[], 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?: T39 }`
|
||||
- `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: T12, totalSizeBytes: int, durationMs: int }`
|
||||
- `T6` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T11, totalSizeBytes: int, durationMs: int }`
|
||||
- `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, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, clientserial?: str|null, clientmodel?: str|null, clientstate?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int }`
|
||||
- `T9` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T39|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T10` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T23[] }, thumb?: str|null }`
|
||||
- `T11` = `{ 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 }`
|
||||
- `T12` = `{ vfs: T38, storage: T38, database: T32 }`
|
||||
- `T13` = `{ 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 }`
|
||||
- `T14` = `{ 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 }`
|
||||
- `T15` = `{ 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 }`
|
||||
- `T16` = `{ id: int, name: str, sort: int, exclusive: bool, values: T28[], articleCount?: int }`
|
||||
- `T17` = `{ 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 }`
|
||||
- `T18` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }`
|
||||
- `T19` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T20` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T21` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T22` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T23` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T24` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T25` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T26` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }`
|
||||
- `T27` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T28` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T29` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T30` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T31` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T32` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }`
|
||||
- `T33` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }`
|
||||
- `T34` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T35` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T36` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T37` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T38` = `{ name: str, sizeBytes: int, sourceExists: bool }`
|
||||
- `T39` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|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: T40, storage: T40, database: T34 }`
|
||||
- `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 }`
|
||||
- `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, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T32` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T33` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T34` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }`
|
||||
- `T35` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }`
|
||||
- `T36` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T37` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T38` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T39` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T40` = `{ name: str, sizeBytes: int, sourceExists: bool }`
|
||||
- `T41` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
|
||||
### Routes
|
||||
|
||||
@@ -86,7 +88,25 @@ _none_
|
||||
- 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: T8 }`
|
||||
- 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: { printeragentId: int, agentprinterIds: 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
|
||||
|
||||
@@ -104,7 +124,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: T27, brand: T26|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: T9[], 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`
|
||||
@@ -179,10 +199,10 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### List article suppliers — `GET /article/{sku}/supplier`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { suppliers: T9[] }`
|
||||
- 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: T9 }`
|
||||
- Returns: `201 { supplier: T8 }`
|
||||
#### Reorder article suppliers — `PUT /article/{sku}/supplier/order`
|
||||
- Params: `sku: str, body: { ids: int[] }`
|
||||
- Returns: `200 { ids: int[] }`
|
||||
@@ -191,7 +211,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: T9 }`
|
||||
- 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`
|
||||
@@ -203,19 +223,19 @@ _none_
|
||||
|
||||
#### List attribute names — `GET /attributename`
|
||||
_none_
|
||||
- Returns: `200 { attributenames: T16[] }`
|
||||
- Returns: `200 { attributenames: T17[] }`
|
||||
#### Create attribute name — `POST /attributename`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { attributename: T16 }`
|
||||
- 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: T28[] }`
|
||||
- Returns: `200 { values: T30[] }`
|
||||
#### Create value for an attribute — `POST /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int, body: { value: str, sort?: int }`
|
||||
- Returns: `201 { attributevalue: T28 }`
|
||||
- Returns: `201 { attributevalue: T30 }`
|
||||
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
||||
- Params: `attributeId: int, body: { attributevalueIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -224,7 +244,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: T16 }`
|
||||
- Returns: `200 { attributename: T17 }`
|
||||
|
||||
### Section: /attributevalue
|
||||
|
||||
@@ -233,28 +253,28 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute value — `PATCH /attributevalue/{id}`
|
||||
- Params: `id: int, body: { value?: str, sort?: int }`
|
||||
- Returns: `200 { attributevalue: T28 }`
|
||||
- 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: T34[] } }`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }`
|
||||
#### 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: T34[] } }`
|
||||
- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }`
|
||||
|
||||
### Section: /auth
|
||||
|
||||
#### Login with Google ID token — `POST /auth/login`
|
||||
- Params: `body: { idToken: str }`
|
||||
- Returns: `200 { message: str, user: T33 }`
|
||||
- Returns: `200 { message: str, user: T35 }`
|
||||
#### Logout — `POST /auth/logout`
|
||||
_none_
|
||||
- Returns: `200 { message: str }`
|
||||
#### Current user — `GET /auth/me`
|
||||
_none_
|
||||
- Returns: `200 { user: T33, googleClientId: str, schemaVersion: int, vhost: bool, vhostSettings: str }`
|
||||
- Returns: `200 { user: T35, googleClientId: str, schemaVersion: int, vhost: bool, vhostSettings: str }`
|
||||
#### Set selected company — `PUT /auth/selected-company`
|
||||
- Params: `body: { companyId: int }`
|
||||
- Returns: `200 { user: T33 }`
|
||||
- Returns: `200 { user: T35 }`
|
||||
|
||||
### Section: /backup
|
||||
|
||||
@@ -275,7 +295,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: T34[], gsprpinfo?: str|null } }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T36[], gsprpinfo?: str|null } }`
|
||||
#### Delete brand — `DELETE /brand/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
@@ -284,19 +304,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: T34[] } }`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }`
|
||||
#### 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: T34[] } }`
|
||||
- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }`
|
||||
|
||||
### Section: /carrier
|
||||
|
||||
#### List carriers — `GET /carrier`
|
||||
_none_
|
||||
- Returns: `200 { carriers: T31[] }`
|
||||
- Returns: `200 { carriers: T33[] }`
|
||||
#### Create carrier — `POST /carrier`
|
||||
- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `201 { carrier: T31 }`
|
||||
- Returns: `201 { carrier: T33 }`
|
||||
#### Reorder carriers — `PUT /carrier/order`
|
||||
- Params: `body: { carrierIds: int[] }`
|
||||
- Returns: `200 { carrierIds: int[] }`
|
||||
@@ -305,10 +325,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Get carrier by ID — `GET /carrier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { carrier: T31 }`
|
||||
- Returns: `200 { carrier: T33 }`
|
||||
#### Update carrier — `PATCH /carrier/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `200 { carrier: T31 }`
|
||||
- Returns: `200 { carrier: T33 }`
|
||||
|
||||
### Section: /category
|
||||
|
||||
@@ -332,7 +352,7 @@ _none_
|
||||
- Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }`
|
||||
#### Articles in category — `GET /category/{id}/articles`
|
||||
- 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?: T26|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 }[] }[] }`
|
||||
- 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 }[] }`
|
||||
@@ -362,10 +382,10 @@ _none_
|
||||
|
||||
#### List companies — `GET /company`
|
||||
_none_
|
||||
- Returns: `200 { companies: T18[] }`
|
||||
- Returns: `200 { companies: T19[] }`
|
||||
#### Create company — `POST /company`
|
||||
- Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `201 { company: T18, user: T33 }`
|
||||
- Returns: `201 { company: T19, user: T35 }`
|
||||
#### Export company catalog as zip archive (SSE) — `GET /company/export`
|
||||
- Params: `query: stream?: str`
|
||||
- Returns: `200 SSE`
|
||||
@@ -395,7 +415,7 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Update company — `PUT /company/{id}`
|
||||
- Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `200 { company: T18 }`
|
||||
- Returns: `200 { company: T19 }`
|
||||
|
||||
### Section: /customergroup
|
||||
|
||||
@@ -419,7 +439,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?: T37 }[], 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?: T39 }[], 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 }`
|
||||
@@ -440,52 +460,52 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T11, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
|
||||
### Section: /entity
|
||||
|
||||
#### List entities — `GET /entity`
|
||||
- Params: `query: customergroupId?: int, role?: str`
|
||||
- Returns: `200 { entities: T25[] }`
|
||||
- Returns: `200 { entities: T27[] }`
|
||||
#### Create entity — `POST /entity`
|
||||
- Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }`
|
||||
- Returns: `201 { entity: T25 }`
|
||||
- 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: T13[] }`
|
||||
- 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: T13 }`
|
||||
- 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: T13 }`
|
||||
- Returns: `200 { address: T14 }`
|
||||
#### List entity contacts — `GET /entity/{entityId}/contact`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { contacts: T35[] }`
|
||||
- Returns: `200 { contacts: T37[] }`
|
||||
#### Create entity contact — `POST /entity/{entityId}/contact`
|
||||
- Params: `entityId: int, body: { contactType: str, contact: str }`
|
||||
- Returns: `201 { contact: T35 }`
|
||||
- Returns: `201 { contact: T37 }`
|
||||
#### 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: T35 }`
|
||||
- Returns: `200 { contact: T37 }`
|
||||
#### Delete entity — `DELETE /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get entity — `GET /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { entity: T25 }`
|
||||
- Returns: `200 { entity: T27 }`
|
||||
#### Update entity — `PATCH /entity/{id}`
|
||||
- Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
|
||||
- Returns: `200 { entity: T25 }`
|
||||
- Returns: `200 { entity: T27 }`
|
||||
|
||||
### Section: /events
|
||||
|
||||
@@ -505,6 +525,9 @@ _none_
|
||||
- `propertyname`: `{}`
|
||||
- `labeltemplate`: `{}`
|
||||
- `printer`: `{}`
|
||||
- `printeragent`: `{}`
|
||||
- `agentprinter`: `{ printers } or {}`
|
||||
- `printerjob`: `{ job } or { jobId, state }`
|
||||
- `warehouse`: `{}`
|
||||
- `supplier`: `{}`
|
||||
- `vfs`: `{}`
|
||||
@@ -533,35 +556,35 @@ _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: T23[] } }`
|
||||
- Returns: `201 { labeltemplate: T10 }`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T25[] } }`
|
||||
- Returns: `201 { labeltemplate: T9 }`
|
||||
#### 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: T10 }`
|
||||
- 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: T23[] } }`
|
||||
- Returns: `200 { labeltemplate: T10 }`
|
||||
- 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: T23[] } }`
|
||||
- Returns: `200 { labeltemplate: T10 }`
|
||||
- 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: T15[] }`
|
||||
- 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: T15[] }`
|
||||
- Returns: `200 { ledger: T16[] }`
|
||||
#### Query ledger by article SKU — `GET /ledger/sku/{sku}`
|
||||
- Params: `sku: str, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T15[] }`
|
||||
- Returns: `200 { ledger: T16[] }`
|
||||
|
||||
### Section: /mcp
|
||||
|
||||
@@ -591,16 +614,16 @@ _none_
|
||||
|
||||
#### List conversations — `GET /modelconversation`
|
||||
_none_
|
||||
- Returns: `200 { conversations: T17[] }`
|
||||
- Returns: `200 { conversations: T18[] }`
|
||||
#### Create conversation — `POST /modelconversation`
|
||||
- Params: `body: { provider: str, model: str }`
|
||||
- Returns: `201 { conversation: T17 }`
|
||||
- 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: T17 }`
|
||||
- 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 }[] }`
|
||||
@@ -641,7 +664,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: T20[], 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`
|
||||
@@ -650,7 +673,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?: T20[] }`
|
||||
- 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`
|
||||
@@ -660,13 +683,13 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### List payments of an order — `GET /order/{id}/payment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { payments: T30[] }`
|
||||
- Returns: `200 { payments: T32[] }`
|
||||
#### Add payment to an order — `POST /order/{id}/payment`
|
||||
- Params: `id: int, body: { accountId: int, type: str, amount: num }`
|
||||
- Returns: `201 { payment: T30 }`
|
||||
- Returns: `201 { payment: T32 }`
|
||||
#### Generate and attach order PDF — `POST /order/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T11, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
#### List shipments of an order — `GET /order/{id}/shipment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shipments: T2[] }`
|
||||
@@ -675,10 +698,10 @@ _none_
|
||||
- Returns: `201 { shipment: T2 }`
|
||||
#### List shippings of an order — `GET /order/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T21[] }`
|
||||
- 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: T21 }`
|
||||
- Returns: `201 { shipping: T23 }`
|
||||
|
||||
### Section: /package
|
||||
|
||||
@@ -723,49 +746,73 @@ _none_
|
||||
|
||||
#### List printers — `GET /printer`
|
||||
_none_
|
||||
- Returns: `200 { printers: T24[] }`
|
||||
- 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: T24 }`
|
||||
- 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: T24 }`
|
||||
- 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: T24 }`
|
||||
- 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: T24 }`
|
||||
- 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: T8[] }`
|
||||
- Returns: `200 { printeragents: T12[] }`
|
||||
#### Create printer agent — `PUT /printeragent`
|
||||
- Params: `body: { name: str, sort?: int }`
|
||||
- Returns: `200 { printeragent: T8 }`
|
||||
- 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 }`
|
||||
- Returns: `200 { printeragent: T8 }`
|
||||
- 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 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: T29[] }`
|
||||
- Returns: `200 { propertynames: T31[] }`
|
||||
#### Create property name — `POST /propertyname`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { propertyname: T29 }`
|
||||
- Returns: `201 { propertyname: T31 }`
|
||||
#### Reorder property names — `PUT /propertyname/order`
|
||||
- Params: `body: { propertynameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -774,7 +821,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: T29 }`
|
||||
- Returns: `200 { propertyname: T31 }`
|
||||
|
||||
### Section: /public
|
||||
|
||||
@@ -786,7 +833,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: T27|null, brand: T26|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 }[] }`
|
||||
@@ -797,7 +844,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: T20[], 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`
|
||||
@@ -806,7 +853,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?: T20[] }`
|
||||
- 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`
|
||||
@@ -815,11 +862,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?: T20[] }`
|
||||
- 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: T11, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
|
||||
### Section: /retoure
|
||||
|
||||
@@ -906,13 +953,13 @@ _none_
|
||||
- Returns: `200 str`
|
||||
#### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T11, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T10, fileUrl: str }`
|
||||
#### List packages of a shipment — `GET /shipment/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T21[] }`
|
||||
- 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: T21 }`
|
||||
- Returns: `201 { shipping: T23 }`
|
||||
|
||||
### Section: /shipping
|
||||
|
||||
@@ -921,7 +968,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: T21 }`
|
||||
- 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 }[] }`
|
||||
@@ -942,7 +989,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: T15[] }`
|
||||
- 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`
|
||||
@@ -951,40 +998,40 @@ _none_
|
||||
|
||||
#### List subagent schedules — `GET /subagentschedule`
|
||||
_none_
|
||||
- Returns: `200 { schedules: T14[] }`
|
||||
- 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: T14 }`
|
||||
- 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: T14 }`
|
||||
- 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: T14 }`
|
||||
- Returns: `200 { schedule: T15 }`
|
||||
|
||||
### Section: /supplier
|
||||
|
||||
#### List suppliers — `GET /supplier`
|
||||
_none_
|
||||
- Returns: `200 { suppliers: T36[] }`
|
||||
- Returns: `200 { suppliers: T38[] }`
|
||||
#### Create supplier — `POST /supplier`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { supplier: T36 }`
|
||||
- Returns: `201 { supplier: T38 }`
|
||||
#### 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: T36 }`
|
||||
- Returns: `200 { supplier: T38 }`
|
||||
#### 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?: T39|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?: T41|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?: T39|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?: T41|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
|
||||
### Section: /thumb
|
||||
|
||||
@@ -999,10 +1046,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### List units — `GET /unit`
|
||||
_none_
|
||||
- Returns: `200 { units: T27[] }`
|
||||
- Returns: `200 { units: T29[] }`
|
||||
#### Upsert unit — `PUT /unit`
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: T27 }`
|
||||
- Returns: `200 { unit: T29 }`
|
||||
|
||||
### Section: /v1
|
||||
|
||||
@@ -1093,3 +1140,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 212 API endpoints across all modules.
|
||||
Overview of all 225 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -9,35 +9,37 @@ 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: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T15|null, shippings?: T15[], payment?: T23|null, payments?: T23[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T8[] }`
|
||||
- `T2` = `{ id: int, number: str, type: str, date: str, lines: T13[], shippings: T15[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T8[], state?: str }`
|
||||
- `T3` = `{ id: int, number: str, type: str, date: str, lines: T13[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T8[] }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T16[], files: T8[], externalNumber?: str|null, createdAt?: str, ledger?: T28 }`
|
||||
- `T5` = `{ id: int, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, clientserial?: str|null, clientmodel?: str|null, clientstate?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int }`
|
||||
- `T6` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T29|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T7` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T17[] }, thumb?: str|null }`
|
||||
- `T8` = `{ 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 }`
|
||||
- `T9` = `{ 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 }`
|
||||
- `T10` = `{ 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 }`
|
||||
- `T11` = `{ 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 }`
|
||||
- `T12` = `{ id: int, name: str, sort: int, exclusive: bool, values: T21[], articleCount?: int }`
|
||||
- `T13` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T14` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T15` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T16` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T17` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T18` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T19` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T20` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T21` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T22` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T23` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T24` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T25` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T26` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T27` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T28` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T29` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T14[], externalNumber?: str|null, createdAt?: str, shipping?: T17|null, shippings?: T17[], payment?: T25|null, payments?: T25[], 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: T14[], shippings: T17[], 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: T14[], 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: T18[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T30 }`
|
||||
- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }`
|
||||
- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] }, 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, 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 }`
|
||||
- `T9` = `{ 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 }`
|
||||
- `T10` = `{ 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 }`
|
||||
- `T11` = `{ 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 }`
|
||||
- `T12` = `{ 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 }`
|
||||
- `T13` = `{ id: int, name: str, sort: int, exclusive: bool, values: T23[], articleCount?: int }`
|
||||
- `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }`
|
||||
- `T15` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }`
|
||||
- `T16` = `{ id: int, agentprinterId: int, type: str, state: str, data: str, createdAt: str, printeragentId?: int|null, completedAt?: str|null }`
|
||||
- `T17` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }`
|
||||
- `T18` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }`
|
||||
- `T19` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }`
|
||||
- `T20` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }`
|
||||
- `T21` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }`
|
||||
- `T22` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }`
|
||||
- `T23` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }`
|
||||
- `T24` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }`
|
||||
- `T25` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }`
|
||||
- `T26` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }`
|
||||
- `T27` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T28` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T29` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T30` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T31` = `{ net: num, taxId: int, taxRate?: num|null }`
|
||||
|
||||
### Routes
|
||||
|
||||
@@ -55,7 +57,25 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
- 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: T5 }`
|
||||
- Returns: `200 { success: bool, agent: T8 }`
|
||||
|
||||
### Section: /agentprinter
|
||||
|
||||
#### List agent printers — `GET /agentprinter`
|
||||
- Params: `query: printeragentId?: int`
|
||||
- Returns: `200 { agentprinters: T9[] }`
|
||||
#### Reorder agent printers — `PUT /agentprinter/order`
|
||||
- Params: `body: { printeragentId: int, agentprinterIds: 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: T9 }`
|
||||
#### Update agent printer — `PATCH /agentprinter/{id}`
|
||||
- Params: `id: int, body: { enabled?: bool, sort?: int }`
|
||||
- Returns: `200 { agentprinter: T9 }`
|
||||
|
||||
### Section: /article
|
||||
|
||||
@@ -70,7 +90,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: T20, 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: T6[], 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: T22, 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`
|
||||
@@ -142,10 +162,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### List article suppliers — `GET /article/{sku}/supplier`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { suppliers: T6[] }`
|
||||
- Returns: `200 { suppliers: T5[] }`
|
||||
#### 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: T6 }`
|
||||
- Returns: `201 { supplier: T5 }`
|
||||
#### Reorder article suppliers — `PUT /article/{sku}/supplier/order`
|
||||
- Params: `sku: str, body: { ids: int[] }`
|
||||
- Returns: `200 { ids: int[] }`
|
||||
@@ -154,7 +174,7 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
- 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: T6 }`
|
||||
- Returns: `200 { supplier: T5 }`
|
||||
#### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock`
|
||||
- Params: `sku: str, body: { track_stock: bool }`
|
||||
- Returns: `204 void`
|
||||
@@ -166,19 +186,19 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
|
||||
|
||||
#### List attribute names — `GET /attributename`
|
||||
_none_
|
||||
- Returns: `200 { attributenames: T12[] }`
|
||||
- Returns: `200 { attributenames: T13[] }`
|
||||
#### Create attribute name — `POST /attributename`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { attributename: T12 }`
|
||||
- Returns: `201 { attributename: T13 }`
|
||||
#### 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: T21[] }`
|
||||
- Returns: `200 { values: T23[] }`
|
||||
#### Create value for an attribute — `POST /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: int, body: { value: str, sort?: int }`
|
||||
- Returns: `201 { attributevalue: T21 }`
|
||||
- Returns: `201 { attributevalue: T23 }`
|
||||
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
||||
- Params: `attributeId: int, body: { attributevalueIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -187,7 +207,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: T12 }`
|
||||
- Returns: `200 { attributename: T13 }`
|
||||
|
||||
### Section: /attributevalue
|
||||
|
||||
@@ -196,10 +216,10 @@ _none_
|
||||
- Returns: `200 { ok: bool }`
|
||||
#### Update attribute value — `PATCH /attributevalue/{id}`
|
||||
- Params: `id: int, body: { value?: str, sort?: int }`
|
||||
- Returns: `200 { attributevalue: T21 }`
|
||||
- Returns: `200 { attributevalue: T23 }`
|
||||
#### 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: T25[] } }`
|
||||
- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }`
|
||||
|
||||
### Section: /brand
|
||||
|
||||
@@ -208,7 +228,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: T25[], gsprpinfo?: str|null } }`
|
||||
- Returns: `201 { brand: { id: int, name: str, pics: T27[], gsprpinfo?: str|null } }`
|
||||
#### Delete brand — `DELETE /brand/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
@@ -217,16 +237,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: T25[] } }`
|
||||
- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }`
|
||||
|
||||
### Section: /carrier
|
||||
|
||||
#### List carriers — `GET /carrier`
|
||||
_none_
|
||||
- Returns: `200 { carriers: T24[] }`
|
||||
- Returns: `200 { carriers: T26[] }`
|
||||
#### Create carrier — `POST /carrier`
|
||||
- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `201 { carrier: T24 }`
|
||||
- Returns: `201 { carrier: T26 }`
|
||||
#### Reorder carriers — `PUT /carrier/order`
|
||||
- Params: `body: { carrierIds: int[] }`
|
||||
- Returns: `200 { carrierIds: int[] }`
|
||||
@@ -235,10 +255,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Get carrier by ID — `GET /carrier/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { carrier: T24 }`
|
||||
- Returns: `200 { carrier: T26 }`
|
||||
#### Update carrier — `PATCH /carrier/{id}`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }`
|
||||
- Returns: `200 { carrier: T24 }`
|
||||
- Returns: `200 { carrier: T26 }`
|
||||
|
||||
### Section: /category
|
||||
|
||||
@@ -331,7 +351,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?: T28 }[], 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?: T30 }[], 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 }`
|
||||
@@ -349,52 +369,52 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T8, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
|
||||
### Section: /entity
|
||||
|
||||
#### List entities — `GET /entity`
|
||||
- Params: `query: customergroupId?: int, role?: str`
|
||||
- Returns: `200 { entities: T19[] }`
|
||||
- Returns: `200 { entities: T21[] }`
|
||||
#### Create entity — `POST /entity`
|
||||
- Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }`
|
||||
- Returns: `201 { entity: T19 }`
|
||||
- Returns: `201 { entity: T21 }`
|
||||
#### 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: T9[] }`
|
||||
- Returns: `200 { addresses: T10[] }`
|
||||
#### 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: T9 }`
|
||||
- Returns: `201 { address: T10 }`
|
||||
#### 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: T9 }`
|
||||
- Returns: `200 { address: T10 }`
|
||||
#### List entity contacts — `GET /entity/{entityId}/contact`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { contacts: T26[] }`
|
||||
- Returns: `200 { contacts: T28[] }`
|
||||
#### Create entity contact — `POST /entity/{entityId}/contact`
|
||||
- Params: `entityId: int, body: { contactType: str, contact: str }`
|
||||
- Returns: `201 { contact: T26 }`
|
||||
- Returns: `201 { contact: T28 }`
|
||||
#### 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: T26 }`
|
||||
- Returns: `200 { contact: T28 }`
|
||||
#### Delete entity — `DELETE /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get entity — `GET /entity/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { entity: T19 }`
|
||||
- Returns: `200 { entity: T21 }`
|
||||
#### Update entity — `PATCH /entity/{id}`
|
||||
- Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
|
||||
- Returns: `200 { entity: T19 }`
|
||||
- Returns: `200 { entity: T21 }`
|
||||
|
||||
### Section: /health
|
||||
|
||||
@@ -408,35 +428,35 @@ _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: T17[] } }`
|
||||
- Returns: `201 { labeltemplate: T7 }`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] } }`
|
||||
- Returns: `201 { labeltemplate: T6 }`
|
||||
#### 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: T7 }`
|
||||
- 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: T17[] } }`
|
||||
- Returns: `200 { labeltemplate: T7 }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }`
|
||||
- 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: T17[] } }`
|
||||
- Returns: `200 { labeltemplate: T7 }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }`
|
||||
- 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: T11[] }`
|
||||
- Returns: `200 { ledger: T12[] }`
|
||||
#### 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: T11[] }`
|
||||
- Returns: `200 { ledger: T12[] }`
|
||||
#### Query ledger by article SKU — `GET /ledger/sku/{sku}`
|
||||
- Params: `sku: str, query: transaction_type?: str`
|
||||
- Returns: `200 { ledger: T11[] }`
|
||||
- Returns: `200 { ledger: T12[] }`
|
||||
|
||||
### Section: /number
|
||||
|
||||
@@ -453,7 +473,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: T14[], externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, entityId: int, lines: T15[], externalNumber?: str|null }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Delete order — `DELETE /order/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -462,20 +482,20 @@ _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?: T14[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }`
|
||||
- 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: T23[] }`
|
||||
- Returns: `200 { payments: T25[] }`
|
||||
#### Add payment to an order — `POST /order/{id}/payment`
|
||||
- Params: `id: int, body: { accountId: int, type: str, amount: num }`
|
||||
- Returns: `201 { payment: T23 }`
|
||||
- Returns: `201 { payment: T25 }`
|
||||
#### Generate and attach order PDF — `POST /order/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T8, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
#### List shipments of an order — `GET /order/{id}/shipment`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shipments: T2[] }`
|
||||
@@ -484,10 +504,10 @@ _none_
|
||||
- Returns: `201 { shipment: T2 }`
|
||||
#### List shippings of an order — `GET /order/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T15[] }`
|
||||
- Returns: `200 { shippings: T17[] }`
|
||||
#### 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: T15 }`
|
||||
- Returns: `201 { shipping: T17 }`
|
||||
|
||||
### Section: /package
|
||||
|
||||
@@ -505,49 +525,73 @@ _none_
|
||||
|
||||
#### List printers — `GET /printer`
|
||||
_none_
|
||||
- Returns: `200 { printers: T18[] }`
|
||||
- Returns: `200 { printers: T20[] }`
|
||||
#### Create printer — `POST /printer`
|
||||
- Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }`
|
||||
- Returns: `201 { printer: T18 }`
|
||||
- Returns: `201 { printer: T20 }`
|
||||
#### 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: T18 }`
|
||||
- Returns: `200 { printer: T20 }`
|
||||
#### 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: T18 }`
|
||||
- Returns: `200 { printer: T20 }`
|
||||
#### 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: T18 }`
|
||||
- Returns: `200 { printer: T20 }`
|
||||
#### 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: T5[] }`
|
||||
- Returns: `200 { printeragents: T8[] }`
|
||||
#### Create printer agent — `PUT /printeragent`
|
||||
- Params: `body: { name: str, sort?: int }`
|
||||
- Returns: `200 { printeragent: T5 }`
|
||||
- Params: `body: { name: str, sort?: int, enabled?: bool }`
|
||||
- Returns: `200 { printeragent: T8 }`
|
||||
#### 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 }`
|
||||
- Returns: `200 { printeragent: T5 }`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, enabled?: bool }`
|
||||
- Returns: `200 { printeragent: T8 }`
|
||||
|
||||
### Section: /printerjob
|
||||
|
||||
#### List printer jobs — `GET /printerjob`
|
||||
- Params: `query: agentprinterId?: int, state?: str`
|
||||
- Returns: `200 { printerjobs: T16[] }`
|
||||
#### Create print job — `POST /printerjob`
|
||||
- Params: `body: { agentprinterId: int, data: str, type?: str }`
|
||||
- Returns: `201 { printerjob: T16 }`
|
||||
#### Cancel and delete printer job — `DELETE /printerjob/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { success: bool, deletedJob: T16 }`
|
||||
#### Get printer job — `GET /printerjob/{id}`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { printerjob: T16 }`
|
||||
#### Cancel printer job — `POST /printerjob/{id}/cancel`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { success: bool, printerjob: T16 }`
|
||||
|
||||
### Section: /propertyname
|
||||
|
||||
#### List property names — `GET /propertyname`
|
||||
_none_
|
||||
- Returns: `200 { propertynames: T22[] }`
|
||||
- Returns: `200 { propertynames: T24[] }`
|
||||
#### Create property name — `POST /propertyname`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { propertyname: T22 }`
|
||||
- Returns: `201 { propertyname: T24 }`
|
||||
#### Reorder property names — `PUT /propertyname/order`
|
||||
- Params: `body: { propertynameIds: int[] }`
|
||||
- Returns: `200 { ok: bool }`
|
||||
@@ -556,7 +600,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: T22 }`
|
||||
- Returns: `200 { propertyname: T24 }`
|
||||
|
||||
### Section: /quote
|
||||
|
||||
@@ -564,7 +608,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: T14[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Params: `body: { number: str, date: str, lines: T15[], entityId?: int|null, externalNumber?: str|null }`
|
||||
- Returns: `201 { quote: T3 }`
|
||||
#### Delete quote — `DELETE /quote/{id}`
|
||||
- Params: `id: int`
|
||||
@@ -573,17 +617,17 @@ _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?: T14[] }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }`
|
||||
- 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?: T14[] }`
|
||||
- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }`
|
||||
- Returns: `201 { order: T1 }`
|
||||
#### Generate and attach quote PDF — `POST /quote/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T8, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
|
||||
### Section: /retoure
|
||||
|
||||
@@ -652,13 +696,13 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf`
|
||||
- Params: `id: int`
|
||||
- Returns: `201 { attachment: T8, fileUrl: str }`
|
||||
- Returns: `201 { attachment: T7, fileUrl: str }`
|
||||
#### List packages of a shipment — `GET /shipment/{id}/shipping`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { shippings: T15[] }`
|
||||
- Returns: `200 { shippings: T17[] }`
|
||||
#### 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: T15 }`
|
||||
- Returns: `201 { shipping: T17 }`
|
||||
|
||||
### Section: /shipping
|
||||
|
||||
@@ -667,7 +711,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: T15 }`
|
||||
- Returns: `200 { shipping: T17 }`
|
||||
#### 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 }[] }`
|
||||
@@ -688,7 +732,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: T11[] }`
|
||||
- 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: T12[] }`
|
||||
#### Ship shipment manifest item(s) — `POST /stock/ship`
|
||||
- Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }`
|
||||
- Returns: `200`
|
||||
@@ -697,40 +741,40 @@ _none_
|
||||
|
||||
#### List subagent schedules — `GET /subagentschedule`
|
||||
_none_
|
||||
- Returns: `200 { schedules: T10[] }`
|
||||
- Returns: `200 { schedules: T11[] }`
|
||||
#### 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: T10 }`
|
||||
- Returns: `201 { schedule: T11 }`
|
||||
#### 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: T10 }`
|
||||
- Returns: `200 { schedule: T11 }`
|
||||
#### 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: T10 }`
|
||||
- Returns: `200 { schedule: T11 }`
|
||||
|
||||
### Section: /supplier
|
||||
|
||||
#### List suppliers — `GET /supplier`
|
||||
_none_
|
||||
- Returns: `200 { suppliers: T27[] }`
|
||||
- Returns: `200 { suppliers: T29[] }`
|
||||
#### Create supplier — `POST /supplier`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { supplier: T27 }`
|
||||
- Returns: `201 { supplier: T29 }`
|
||||
#### 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: T27 }`
|
||||
- Returns: `200 { supplier: T29 }`
|
||||
#### 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?: T29|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?: T31|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?: T29|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?: T31|null, incoming?: { date: str, amount: num }[] }[] }`
|
||||
|
||||
### Section: /unit
|
||||
|
||||
@@ -739,10 +783,10 @@ _none_
|
||||
- Returns: `204 void`
|
||||
#### List units — `GET /unit`
|
||||
_none_
|
||||
- Returns: `200 { units: T20[] }`
|
||||
- Returns: `200 { units: T22[] }`
|
||||
#### Upsert unit — `PUT /unit`
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: T20 }`
|
||||
- Returns: `200 { unit: T22 }`
|
||||
|
||||
### Section: /v1
|
||||
|
||||
@@ -776,6 +820,12 @@ _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: T16 }`
|
||||
### Binary & streaming routes (reachable only via `fetch()` in javascript_execute)
|
||||
|
||||
These routes are NOT in the table above because their payloads (binary request body or binary response) or long-lived streams cannot be handled usefully by the `dashback_request` tool. They ARE reachable from inside `javascript_execute` with `fetch("/route")`:
|
||||
|
||||
@@ -33,13 +33,11 @@ State recorded
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"clientserial": "…",
|
||||
"clientmodel": "…",
|
||||
"clientstate": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
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` | yes | integer | |
|
||||
| `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`._
|
||||
@@ -46,6 +46,9 @@ emits `{ sender, brandId }`.
|
||||
| `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 |
|
||||
| `printerjob` | `{ job }` or `{ jobId, state }` | `POST /zpljob`, `POST /printerjob`, `POST /printerjob/{id}/cancel`, `DELETE /printerjob/{id}`, agent job state updates |
|
||||
| `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}` |
|
||||
|
||||
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`._
|
||||
@@ -20,13 +20,11 @@ Printer agent list
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"clientserial": "…",
|
||||
"clientmodel": "…",
|
||||
"clientstate": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -14,6 +14,7 @@ The pairingpin is randomly generated server-side and returned in the response.
|
||||
|-------|----------|------|-------------|
|
||||
| `name` | yes | string | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -34,13 +35,11 @@ Created printer agent with generated pairingpin
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"clientserial": "…",
|
||||
"clientmodel": "…",
|
||||
"clientstate": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -18,11 +18,13 @@ Updates name and/or display order (sort) of a printer agent.
|
||||
|-------|----------|------|-------------|
|
||||
| `name` | no | string | |
|
||||
| `sort` | no | integer | |
|
||||
| `enabled` | no | boolean | |
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "…",
|
||||
"sort": 1
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
```
|
||||
|
||||
@@ -39,13 +41,11 @@ Updated printer agent
|
||||
"token": "…",
|
||||
"pairingpin": "…",
|
||||
"pairedAt": "…",
|
||||
"clientserial": "…",
|
||||
"clientmodel": "…",
|
||||
"clientstate": "…",
|
||||
"agentversion": "…",
|
||||
"lastseenAt": "…",
|
||||
"updatedAt": "…",
|
||||
"sort": 1
|
||||
"sort": 1,
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
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`._
|
||||
50
docs/api/routes/printerjob.post.md
Normal file
50
docs/api/routes/printerjob.post.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# `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": "…"
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)).
|
||||
|
||||
## 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`._
|
||||
43
docs/api/routes/printerjob/_id.delete.md
Normal file
43
docs/api/routes/printerjob/_id.delete.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# `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 | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)).
|
||||
|
||||
## 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`._
|
||||
41
docs/api/routes/printerjob/_id/cancel.md
Normal file
41
docs/api/routes/printerjob/_id/cancel.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# `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 | |
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)).
|
||||
|
||||
## 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`._
|
||||
60
docs/api/routes/zpljob.md
Normal file
60
docs/api/routes/zpljob.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# `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"
|
||||
}
|
||||
```
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `printerjob` (see [`GET /events`](../events.md)).
|
||||
|
||||
## 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`._
|
||||
@@ -1,8 +1,23 @@
|
||||
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();
|
||||
|
||||
@@ -188,6 +203,36 @@ async function handlePair(req, res) {
|
||||
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);
|
||||
if (!conns || conns.size === 0) 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.write(`event: printerjob\ndata: ${payload}\n\n`);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /agent/events:
|
||||
@@ -233,6 +278,21 @@ agentRouter.get('/events', agentAuthMiddleware, async (req, res) => {
|
||||
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(() => {
|
||||
@@ -241,8 +301,24 @@ agentRouter.get('/events', agentAuthMiddleware, async (req, res) => {
|
||||
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);
|
||||
@@ -287,29 +363,152 @@ agentRouter.get('/events', agentAuthMiddleware, async (req, res) => {
|
||||
async function handleState(req, res) {
|
||||
try {
|
||||
const rawState = req.body?.state !== undefined ? req.body.state : (req.body?.clientstate !== undefined ? req.body.clientstate : req.body);
|
||||
const stateStr = rawState == null ? null : (typeof rawState === 'string' ? rawState : JSON.stringify(rawState));
|
||||
|
||||
const updated = await db.updateState(req.agent.id, stateStr);
|
||||
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);
|
||||
}
|
||||
|
||||
if (updated.companyId) {
|
||||
emit('printeragent', { companyId: updated.companyId });
|
||||
const rawPrinters = Array.isArray(rawState?.printers)
|
||||
? rawState.printers
|
||||
: (Array.isArray(req.body?.printers) ? req.body.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 (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: updated,
|
||||
agent,
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('Agent post state failed:', 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');
|
||||
if (req.agent?.companyId) {
|
||||
emit('printerjob', { companyId: req.agent.companyId, data: { job } });
|
||||
}
|
||||
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');
|
||||
if (req.agent?.companyId) {
|
||||
emit('printerjob', { companyId: req.agent.companyId, data: { job } });
|
||||
}
|
||||
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);
|
||||
if (req.agent?.companyId) {
|
||||
emit('printerjob', { companyId: req.agent.companyId, data: { job } });
|
||||
}
|
||||
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;
|
||||
}
|
||||
|
||||
@@ -63,7 +63,7 @@ export const authMiddleware = async (req, res, next) => {
|
||||
return next();
|
||||
}
|
||||
|
||||
if (req.path.startsWith('/api/agent')) {
|
||||
if (req.path === '/api/agent' || req.path.startsWith('/api/agent/')) {
|
||||
return next();
|
||||
}
|
||||
|
||||
|
||||
@@ -1735,15 +1735,6 @@
|
||||
* pairedAt:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* clientserial:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* clientmodel:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* clientstate:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* agentversion:
|
||||
* type: string
|
||||
* nullable: true
|
||||
@@ -1756,6 +1747,86 @@
|
||||
* 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]
|
||||
|
||||
@@ -44,6 +44,7 @@ export const openApiOptions = {
|
||||
{ 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' },
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
@@ -9,6 +9,7 @@ import { emit } from '../sse.js';
|
||||
import { initCompanyVfs } from '../../tools/vfs.js';
|
||||
import { executeCompanyImport } from '../../services/companyImport.js';
|
||||
import { executeCompanyExport } from '../../services/companyExport.js';
|
||||
import { clearCompanyPrinters } from '../../services/companyPrinterService.js';
|
||||
|
||||
// #region Helpers
|
||||
|
||||
@@ -969,6 +970,7 @@ export function register(app, basePath = '') {
|
||||
|
||||
try {
|
||||
await db.deleteCompany(parsedId.companyId);
|
||||
clearCompanyPrinters(parsedId.companyId);
|
||||
res.sendStatus(204);
|
||||
} catch (error) {
|
||||
console.error('Delete company failed:', error);
|
||||
|
||||
@@ -55,6 +55,9 @@ export function register(app, basePath = '') {
|
||||
* | `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 |
|
||||
* | `printerjob` | `{ job }` or `{ jobId, state }` | `POST /zpljob`, `POST /printerjob`, `POST /printerjob/{id}/cancel`, `DELETE /printerjob/{id}`, agent job state updates |
|
||||
* | `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}` |
|
||||
@@ -97,6 +100,12 @@ export function register(app, basePath = '') {
|
||||
* payload: "{}"
|
||||
* - name: printer
|
||||
* payload: "{}"
|
||||
* - name: printeragent
|
||||
* payload: "{}"
|
||||
* - name: agentprinter
|
||||
* payload: "{ printers } or {}"
|
||||
* - name: printerjob
|
||||
* payload: "{ job } or { jobId, state }"
|
||||
* - name: warehouse
|
||||
* payload: "{}"
|
||||
* - name: supplier
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
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
|
||||
|
||||
@@ -92,7 +94,7 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
const printeragents = await db.list(req.user.id);
|
||||
const printeragents = (await db.list(req.user.id)).map(enrichAgentWithState);
|
||||
res.status(200).json({ printeragents });
|
||||
} catch (error) {
|
||||
const status = printeragentErrorStatus(error);
|
||||
@@ -126,6 +128,8 @@ export function register(app, basePath = '') {
|
||||
* type: string
|
||||
* sort:
|
||||
* type: integer
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* default: 0
|
||||
* example:
|
||||
* name: "Bar printer"
|
||||
@@ -193,7 +197,8 @@ export function register(app, basePath = '') {
|
||||
pairingpin,
|
||||
sort,
|
||||
});
|
||||
res.status(200).json({ printeragent });
|
||||
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);
|
||||
@@ -229,6 +234,8 @@ export function register(app, basePath = '') {
|
||||
* type: string
|
||||
* sort:
|
||||
* type: integer
|
||||
* enabled:
|
||||
* type: boolean
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Updated printer agent
|
||||
@@ -278,8 +285,8 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
const { name } = req.body ?? {};
|
||||
if (name === undefined && req.body?.sort === undefined) {
|
||||
return res.status(400).json({ error: 'name or sort is required' });
|
||||
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())) {
|
||||
@@ -297,10 +304,12 @@ export function register(app, basePath = '') {
|
||||
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);
|
||||
res.status(200).json({ printeragent });
|
||||
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);
|
||||
@@ -367,6 +376,8 @@ export function register(app, basePath = '') {
|
||||
|
||||
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);
|
||||
|
||||
388
src/api/routes/printerjob.js
Normal file
388
src/api/routes/printerjob.js
Normal file
@@ -0,0 +1,388 @@
|
||||
import * as printerjobDb from '../../db/printerjob.js';
|
||||
import { emit } from '../sse.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: []
|
||||
* x-signals: [printerjob]
|
||||
* 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 ?? 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);
|
||||
}
|
||||
|
||||
emit('printerjob', { companyId: selected.companyId, data: { 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/{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: []
|
||||
* x-signals: [printerjob]
|
||||
* 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);
|
||||
}
|
||||
|
||||
emit('printerjob', { companyId: selected.companyId, data: { 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: []
|
||||
* x-signals: [printerjob]
|
||||
* 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);
|
||||
}
|
||||
|
||||
emit('printerjob', {
|
||||
companyId: selected.companyId,
|
||||
data: { jobId: job.id, state: 'cancelled' },
|
||||
});
|
||||
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
|
||||
}
|
||||
|
||||
176
src/api/routes/zpljob.js
Normal file
176
src/api/routes/zpljob.js
Normal file
@@ -0,0 +1,176 @@
|
||||
import * as printerjobDb from '../../db/printerjob.js';
|
||||
import { emit } from '../sse.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;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adjusts or inserts the ZPL print quantity command (^PQ) in the ZPL payload.
|
||||
*
|
||||
* @param {string} data - Raw ZPL string.
|
||||
* @param {number|string} [copiescount=1] - Number of copies.
|
||||
* @returns {string}
|
||||
*/
|
||||
export function applyZplCopies(data, copiescount) {
|
||||
if (!data || typeof data !== 'string') return data;
|
||||
const copies = Number(copiescount);
|
||||
if (!Number.isInteger(copies) || copies <= 1) return data;
|
||||
|
||||
if (/\^PQ\d+/i.test(data)) {
|
||||
return data.replace(/\^PQ\d+/gi, `^PQ${copies}`);
|
||||
}
|
||||
|
||||
if (/\^XZ/i.test(data)) {
|
||||
return data.replace(/\^XZ/gi, `^PQ${copies}\n^XZ`);
|
||||
}
|
||||
|
||||
return `${data}\n^PQ${copies}`;
|
||||
}
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* Registers zpljob routes.
|
||||
* @param {import('express').Application} app
|
||||
* @param {string} [basePath='']
|
||||
*/
|
||||
export function register(app, basePath = '') {
|
||||
/**
|
||||
* @openapi
|
||||
* /zpljob:
|
||||
* post:
|
||||
* tags: [PrinterJob]
|
||||
* summary: Create ZPL print job
|
||||
* description: |
|
||||
* 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.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [printerjob]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [agentprinterId, data]
|
||||
* properties:
|
||||
* agentprinterId:
|
||||
* type: integer
|
||||
* description: Target agent printer ID
|
||||
* example: 1
|
||||
* copiescount:
|
||||
* type: integer
|
||||
* description: Optional copy count (defaults to 1)
|
||||
* default: 1
|
||||
* example: 2
|
||||
* data:
|
||||
* type: string
|
||||
* description: Raw ZPL string
|
||||
* example: "^XA^FO50,50^ADN,36,20^FDHello Zebra^FS^XZ"
|
||||
* responses:
|
||||
* 201:
|
||||
* description: Print job created
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* printerjob:
|
||||
* $ref: '#/components/schemas/Printerjob'
|
||||
* 400:
|
||||
* description: Invalid input or missing fields
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 401:
|
||||
* description: Unauthorized
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Agent printer not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region POST /zpljob
|
||||
|
||||
app.post(`${basePath}/zpljob`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const rawApId = req.body?.agentprinterId ?? 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 rawCopies = req.body?.copiescount ?? req.body?.copiesCount ?? req.body?.copies;
|
||||
const copies = rawCopies != null ? Number(rawCopies) : 1;
|
||||
if (!Number.isInteger(copies) || copies <= 0) {
|
||||
return res.status(400).json({ error: 'copiescount must be a positive integer' });
|
||||
}
|
||||
|
||||
const finalData = applyZplCopies(rawData.trim(), copies);
|
||||
|
||||
try {
|
||||
const job = await printerjobDb.create(req.user.id, {
|
||||
agentprinterId: parsedApId.id,
|
||||
type: 'zpl',
|
||||
data: finalData,
|
||||
});
|
||||
|
||||
if (job.printeragentId) {
|
||||
notifyAgentJob(job.printeragentId, 'created', job);
|
||||
}
|
||||
|
||||
emit('printerjob', { companyId: selected.companyId, data: { job } });
|
||||
res.status(201).json({ printerjob: job });
|
||||
} catch (error) {
|
||||
const status = printerjobErrorStatus(error);
|
||||
if (status === 500) console.error('Create zpljob failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
|
||||
32
src/db/agentprinter.js
Normal file
32
src/db/agentprinter.js
Normal file
@@ -0,0 +1,32 @@
|
||||
import { getStore } from './store.js';
|
||||
|
||||
export async function list(googleAuthId, printeragentId) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.list(googleAuthId, printeragentId);
|
||||
}
|
||||
|
||||
export async function getById(googleAuthId, id) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.getById(googleAuthId, id);
|
||||
}
|
||||
|
||||
export async function findOrCreate(printeragentId, data) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.findOrCreate(printeragentId, data);
|
||||
}
|
||||
|
||||
export async function update(googleAuthId, data) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.update(googleAuthId, data);
|
||||
}
|
||||
|
||||
export async function order(googleAuthId, data) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.order(googleAuthId, data);
|
||||
}
|
||||
|
||||
export async function remove(googleAuthId, id) {
|
||||
const store = await getStore();
|
||||
return store.agentprinter.delete(googleAuthId, id);
|
||||
}
|
||||
|
||||
27
src/db/printerjob.js
Normal file
27
src/db/printerjob.js
Normal file
@@ -0,0 +1,27 @@
|
||||
import { getStore } from './store.js';
|
||||
|
||||
export async function create(googleAuthId, input) {
|
||||
const store = await getStore();
|
||||
return store.printerjob.create(googleAuthId, input);
|
||||
}
|
||||
|
||||
export async function getById(auth, id) {
|
||||
const store = await getStore();
|
||||
return store.printerjob.getById(auth, id);
|
||||
}
|
||||
|
||||
export async function list(auth, filters) {
|
||||
const store = await getStore();
|
||||
return store.printerjob.list(auth, filters);
|
||||
}
|
||||
|
||||
export async function updateState(auth, id, state) {
|
||||
const store = await getStore();
|
||||
return store.printerjob.updateState(auth, id, state);
|
||||
}
|
||||
|
||||
export async function deleteJob(googleAuthId, id) {
|
||||
const store = await getStore();
|
||||
return store.printerjob.delete(googleAuthId, id);
|
||||
}
|
||||
|
||||
@@ -42,6 +42,9 @@ const STORE_NAMESPACES = [
|
||||
'ledger',
|
||||
'warehouse',
|
||||
'printer',
|
||||
'printeragent',
|
||||
'agentprinter',
|
||||
'printerjob',
|
||||
'labeltemplate',
|
||||
'stock',
|
||||
'propertyname',
|
||||
|
||||
274
src/services/companyPrinterService.js
Normal file
274
src/services/companyPrinterService.js
Normal file
@@ -0,0 +1,274 @@
|
||||
import { emit } from '../api/sse.js';
|
||||
import { createLogger } from '../util/logger.js';
|
||||
|
||||
const log = createLogger('printer');
|
||||
|
||||
/**
|
||||
* Global in-memory registry of live printer states per company.
|
||||
* Structure: Map<companyId, Map<agentId, Array<LivePrinter>>>
|
||||
*
|
||||
* @typedef {object} LivePrinter
|
||||
* @property {number} agentId
|
||||
* @property {string|null} agentName
|
||||
* @property {string} updatedAt
|
||||
* @property {string} [model]
|
||||
* @property {string} [serial]
|
||||
* @property {string} [name]
|
||||
* @property {string} [ip]
|
||||
* @property {string} [address]
|
||||
* @property {number} [labelLength]
|
||||
* @property {object} [errors]
|
||||
* @property {boolean} [ready]
|
||||
* @property {string} [status]
|
||||
*/
|
||||
|
||||
/** @type {Map<number, Map<number, LivePrinter[]>>} */
|
||||
const companyAgents = new Map();
|
||||
|
||||
/**
|
||||
* Normalizes an array of printer objects reported by an agent and registers them for the given company.
|
||||
* Broadcasts the updated whole company printer state via SSE.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {number} agentId
|
||||
* @param {string|null} agentName
|
||||
* @param {Array<object>} rawPrinters
|
||||
* @returns {LivePrinter[]} The complete list of live printers for this company across all agents.
|
||||
*/
|
||||
export function updateAgentPrinters(companyId, agentId, agentName, rawPrinters) {
|
||||
const cId = Number(companyId);
|
||||
const aId = Number(agentId);
|
||||
if (!Number.isInteger(cId) || cId <= 0 || !Number.isInteger(aId) || aId <= 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
if (!companyAgents.has(cId)) {
|
||||
companyAgents.set(cId, new Map());
|
||||
}
|
||||
|
||||
const now = new Date().toISOString();
|
||||
const printerList = Array.isArray(rawPrinters) ? rawPrinters : [];
|
||||
const normalized = printerList.map((p) => {
|
||||
const liveStatus = extractLiveStatus(p);
|
||||
return {
|
||||
...p,
|
||||
agentId: aId,
|
||||
agentName: agentName || null,
|
||||
updatedAt: now,
|
||||
...liveStatus,
|
||||
};
|
||||
});
|
||||
|
||||
companyAgents.get(cId).set(aId, normalized);
|
||||
|
||||
const allCompanyPrinters = getCompanyPrinters(cId);
|
||||
log.info(`Updated ${normalized.length} live printer(s) for company ${cId} (agent ${aId}, total ${allCompanyPrinters.length})`);
|
||||
|
||||
broadcastCompanyPrinters(cId, allCompanyPrinters);
|
||||
return allCompanyPrinters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all printers associated with a disconnected agent and broadcasts the updated company printer state.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {number} agentId
|
||||
* @returns {LivePrinter[]} The remaining live printers for this company.
|
||||
*/
|
||||
export function removeAgentPrinters(companyId, agentId) {
|
||||
const cId = Number(companyId);
|
||||
const aId = Number(agentId);
|
||||
if (!Number.isInteger(cId) || cId <= 0 || !Number.isInteger(aId) || aId <= 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const agentsMap = companyAgents.get(cId);
|
||||
if (!agentsMap || !agentsMap.has(aId)) {
|
||||
return getCompanyPrinters(cId);
|
||||
}
|
||||
|
||||
const removedCount = agentsMap.get(aId)?.length || 0;
|
||||
agentsMap.delete(aId);
|
||||
|
||||
if (agentsMap.size === 0) {
|
||||
companyAgents.delete(cId);
|
||||
}
|
||||
|
||||
const remainingPrinters = getCompanyPrinters(cId);
|
||||
log.info(`Removed ${removedCount} live printer(s) for disconnected agent ${aId} from company ${cId} (${remainingPrinters.length} remaining)`);
|
||||
|
||||
broadcastCompanyPrinters(cId, remainingPrinters);
|
||||
return remainingPrinters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all active discovered printers for a company across all reporting agents.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @returns {LivePrinter[]}
|
||||
*/
|
||||
export function getCompanyPrinters(companyId) {
|
||||
const cId = Number(companyId);
|
||||
const agentsMap = companyAgents.get(cId);
|
||||
if (!agentsMap) return [];
|
||||
|
||||
const result = [];
|
||||
for (const printers of agentsMap.values()) {
|
||||
result.push(...printers);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds a single live printer by ID, serial, IP/address, or name.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {string|number} identifier
|
||||
* @returns {LivePrinter|null}
|
||||
*/
|
||||
export function getCompanyPrinter(companyId, identifier) {
|
||||
if (identifier == null) return null;
|
||||
const key = String(identifier).trim().toLowerCase();
|
||||
if (!key) return null;
|
||||
|
||||
const printers = getCompanyPrinters(companyId);
|
||||
return printers.find((p) => {
|
||||
if (p.id != null && String(p.id).toLowerCase() === key) return true;
|
||||
if (p.serial && String(p.serial).toLowerCase() === key) return true;
|
||||
if (p.ip && String(p.ip).toLowerCase() === key) return true;
|
||||
if (p.address && String(p.address).toLowerCase() === key) return true;
|
||||
if (p.name && String(p.name).toLowerCase() === key) return true;
|
||||
return false;
|
||||
}) || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Broadcasts the current live printer list for a company to all connected subscribers via SSE.
|
||||
* Emits `agentprinter` with data `{ printers }`.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {LivePrinter[]} [printers]
|
||||
*/
|
||||
export function broadcastCompanyPrinters(companyId, printers) {
|
||||
const cId = Number(companyId);
|
||||
if (!Number.isInteger(cId) || cId <= 0) return;
|
||||
|
||||
const list = printers ?? getCompanyPrinters(cId);
|
||||
const payload = { printers: list };
|
||||
|
||||
emit('agentprinter', { companyId: cId, data: payload });
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts normalized boolean live status indicators and telemetry from live printer telemetry.
|
||||
*
|
||||
* @param {object|null|undefined} live
|
||||
* @returns {{ open: boolean, pause: boolean, error: boolean, online: boolean, labelLength: number|null }}
|
||||
*/
|
||||
export function extractLiveStatus(live) {
|
||||
if (!live) {
|
||||
return {
|
||||
open: false,
|
||||
pause: false,
|
||||
error: false,
|
||||
online: false,
|
||||
labelLength: null,
|
||||
};
|
||||
}
|
||||
|
||||
const errors = live.errors || {};
|
||||
const isOffline = live.status === 'offline' || live.unreachable === true || errors.unreachable === true;
|
||||
const online = !isOffline;
|
||||
|
||||
const open = Boolean(live.open ?? live.headOpen ?? errors.headOpen ?? false);
|
||||
const pause = Boolean(live.pause ?? live.paused ?? errors.pause ?? false);
|
||||
|
||||
const hasOtherError = Boolean(
|
||||
live.error ||
|
||||
errors.other ||
|
||||
errors.error ||
|
||||
Object.entries(errors).some(([key, val]) => !['headOpen', 'pause', 'unreachable'].includes(key) && Boolean(val))
|
||||
);
|
||||
|
||||
const rawLabelLength = live.labelLength ?? live.labellength;
|
||||
const labelLength = rawLabelLength != null && Number.isFinite(Number(rawLabelLength))
|
||||
? Number(rawLabelLength)
|
||||
: null;
|
||||
|
||||
return {
|
||||
open,
|
||||
pause,
|
||||
error: hasOtherError,
|
||||
online,
|
||||
labelLength,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds a matching live printer from memory for a given database agentprinter record.
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {object} agentprinter
|
||||
* @returns {LivePrinter|null}
|
||||
*/
|
||||
export function getLivePrinterForAgentPrinter(companyId, agentprinter) {
|
||||
const printers = getCompanyPrinters(companyId);
|
||||
if (!agentprinter || printers.length === 0) return null;
|
||||
|
||||
if (agentprinter.id != null) {
|
||||
const match = printers.find((p) => p.agentprinterId === agentprinter.id);
|
||||
if (match) return match;
|
||||
}
|
||||
|
||||
if (agentprinter.printeragentId && agentprinter.serial) {
|
||||
const match = printers.find((p) =>
|
||||
Number(p.agentId) === Number(agentprinter.printeragentId) &&
|
||||
p.serial &&
|
||||
String(p.serial).trim().toLowerCase() === String(agentprinter.serial).trim().toLowerCase()
|
||||
);
|
||||
if (match) return match;
|
||||
}
|
||||
|
||||
if (agentprinter.printeragentId && agentprinter.model) {
|
||||
const match = printers.find((p) =>
|
||||
Number(p.agentId) === Number(agentprinter.printeragentId) &&
|
||||
p.model &&
|
||||
String(p.model).trim().toLowerCase() === String(agentprinter.model).trim().toLowerCase() &&
|
||||
(!agentprinter.type || !p.type || String(p.type).trim().toLowerCase() === String(agentprinter.type).trim().toLowerCase())
|
||||
);
|
||||
if (match) return match;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enriches an agentprinter database record with live operational status (open, pause, error, online).
|
||||
*
|
||||
* @param {number} companyId
|
||||
* @param {object} agentprinter
|
||||
* @returns {object}
|
||||
*/
|
||||
export function enrichAgentPrinter(companyId, agentprinter) {
|
||||
if (!agentprinter) return agentprinter;
|
||||
const live = getLivePrinterForAgentPrinter(companyId, agentprinter);
|
||||
const status = extractLiveStatus(live);
|
||||
return {
|
||||
...agentprinter,
|
||||
...status,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all live printers for a company (e.g. on company deletion).
|
||||
*
|
||||
* @param {number} companyId
|
||||
*/
|
||||
export function clearCompanyPrinters(companyId) {
|
||||
const cId = Number(companyId);
|
||||
if (companyAgents.has(cId)) {
|
||||
companyAgents.delete(cId);
|
||||
broadcastCompanyPrinters(cId, []);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,6 +68,8 @@ const DIVISION_COLORS = {
|
||||
event: chalk.hex('#a855f7'), // Violet
|
||||
backup: chalk.hex('#06b6d4'), // Cyan
|
||||
schema: chalk.hex('#0ea5e9'), // Sky blue
|
||||
agent: chalk.hex('#38bdf8'), // Sky blue
|
||||
printer: chalk.hex('#818cf8'), // Indigo
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user