From 72d05a34d0aaa1661d760f50c8a53694efc7cea0 Mon Sep 17 00:00:00 2001 From: seb Date: Sat, 31 Oct 2026 20:28:37 +0100 Subject: [PATCH] u --- docs/api/README.md | 8 + docs/api/routes-all.md | 181 +++++---- docs/api/routes.md | 153 ++++---- docs/api/routes/agent/state.md | 6 +- docs/api/routes/agentprinter.md | 46 +++ docs/api/routes/agentprinter/_id.delete.md | 35 ++ docs/api/routes/agentprinter/_id.get.md | 43 +++ docs/api/routes/agentprinter/_id.patch.md | 62 ++++ docs/api/routes/agentprinter/order.md | 51 +++ docs/api/routes/events.md | 2 + docs/api/routes/printer/_id/state.md | 37 ++ docs/api/routes/printer/state.md | 39 ++ docs/api/routes/printeragent.get.md | 6 +- docs/api/routes/printeragent.put.md | 7 +- docs/api/routes/printeragent/_id.patch.md | 10 +- src/api/agent/index.js | 96 ++++- src/api/agent/stateStore.js | 75 ++++ src/api/openapi.js | 36 +- src/api/openapiSpec.js | 1 + src/api/routes/agentprinter.js | 410 +++++++++++++++++++++ src/api/routes/company.js | 2 + src/api/routes/events.js | 2 + src/api/routes/printer.js | 193 +++++++++- src/api/routes/printeragent.js | 21 +- src/db/agentprinter.js | 32 ++ src/services/companyPrinterService.js | 171 +++++++++ src/util/logger.js | 2 + 27 files changed, 1546 insertions(+), 181 deletions(-) create mode 100644 docs/api/routes/agentprinter.md create mode 100644 docs/api/routes/agentprinter/_id.delete.md create mode 100644 docs/api/routes/agentprinter/_id.get.md create mode 100644 docs/api/routes/agentprinter/_id.patch.md create mode 100644 docs/api/routes/agentprinter/order.md create mode 100644 docs/api/routes/printer/_id/state.md create mode 100644 docs/api/routes/printer/state.md create mode 100644 src/api/agent/stateStore.js create mode 100644 src/api/routes/agentprinter.js create mode 100644 src/db/agentprinter.js create mode 100644 src/services/companyPrinterService.js diff --git a/docs/api/README.md b/docs/api/README.md index d34f894..6f6a18b 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -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,10 +228,12 @@ 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}` | @@ -333,6 +340,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-` | `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` | diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 228e9b9..2d764a8 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -1,6 +1,6 @@ # Dash API Routes Overview (All) -Overview of all 292 API endpoints across all modules. +Overview of all 299 API endpoints across all modules. ### Notation @@ -9,22 +9,22 @@ 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: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T21|null, shippings?: T21[], payment?: T31|null, payments?: T31[], 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: T19[], shippings: T21[], 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: T19[], 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: T22[], files: T10[], externalNumber?: str|null, createdAt?: str, ledger?: T38 }` - `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 }` +- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null, incoming?: { date: str, amount: num }[] }` +- `T9` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T23[] }, 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: T39, storage: T39, database: T33 }` +- `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, 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 }` +- `T16` = `{ id: int, name: str, sort: int, exclusive: bool, values: T29[], 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 }` @@ -34,20 +34,21 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - `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 }` +- `T26` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null }` +- `T27` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T28` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T29` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T30` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T31` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T32` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T33` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T34` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T35` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T36` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T37` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T38` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T39` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T40` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -86,7 +87,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: T26[] }` +#### 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: T26 }` +#### Update agent printer — `PATCH /agentprinter/{id}` +- Params: `id: int, body: { enabled?: bool, sort?: int }` +- Returns: `200 { agentprinter: T26 }` ### Section: /article @@ -104,7 +123,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: T28, brand: T27|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 +198,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 +210,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` @@ -212,10 +231,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T28[] }` +- Returns: `200 { values: T29[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T28 }` +- Returns: `201 { attributevalue: T29 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -233,28 +252,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: T29 }` #### 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: T35[] } }` #### 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: T35[] } }` ### 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: T34 }` #### 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: T34, 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: T34 }` ### Section: /backup @@ -275,7 +294,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: T35[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -284,19 +303,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: T35[] } }` #### 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: T35[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T31[] }` +- Returns: `200 { carriers: T32[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T31 }` +- Returns: `201 { carrier: T32 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -305,10 +324,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T31 }` +- Returns: `200 { carrier: T32 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T31 }` +- Returns: `200 { carrier: T32 }` ### Section: /category @@ -332,7 +351,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?: T27|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 }[] }` @@ -365,7 +384,7 @@ _none_ - Returns: `200 { companies: T18[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T18, user: T33 }` +- Returns: `201 { company: T18, user: T34 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -419,7 +438,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?: T38 }[], 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,7 +459,7 @@ _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 @@ -467,16 +486,16 @@ _none_ - Returns: `200 { address: T13 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T35[] }` +- Returns: `200 { contacts: T36[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T35 }` +- Returns: `201 { contact: T36 }` #### 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: T36 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` @@ -534,19 +553,19 @@ _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 }` +- 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 }` +- 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 }` +- Returns: `200 { labeltemplate: T9 }` ### Section: /ledger @@ -660,13 +679,13 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T30[] }` +- Returns: `200 { payments: T31[] }` #### 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: T31 }` #### 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[] }` @@ -730,6 +749,9 @@ _none_ #### 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` @@ -742,30 +764,33 @@ _none_ #### 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 }` +#### 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: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T29[] }` +- Returns: `200 { propertynames: T30[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T29 }` +- Returns: `201 { propertyname: T30 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -774,7 +799,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: T30 }` ### Section: /public @@ -786,7 +811,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: T28|null, brand: T27|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 }[] }` @@ -819,7 +844,7 @@ _none_ - 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,7 +931,7 @@ _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[] }` @@ -969,22 +994,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T36[] }` +- Returns: `200 { suppliers: T37[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T36 }` +- Returns: `201 { supplier: T37 }` #### 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: T37 }` #### 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?: T40|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?: T40|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /thumb @@ -999,10 +1024,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T27[] }` +- Returns: `200 { units: T28[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T27 }` +- Returns: `200 { unit: T28 }` ### Section: /v1 diff --git a/docs/api/routes.md b/docs/api/routes.md index cb46ba4..9a6f559 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -1,6 +1,6 @@ # Dash API Routes Overview -Overview of all 212 API endpoints across all modules. +Overview of all 219 API endpoints across all modules. ### Notation @@ -9,18 +9,18 @@ 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 }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T15|null, shippings?: T15[], payment?: T24|null, payments?: T24[], 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: T13[], shippings: T15[], 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: T13[], 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: T16[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T29 }` +- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T30|null, incoming?: { date: str, amount: num }[] }` +- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T17[] }, 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, 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 }` +- `T12` = `{ id: int, name: str, sort: int, exclusive: bool, values: T22[], 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 }` @@ -28,16 +28,17 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - `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 }` +- `T20` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null }` +- `T21` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T22` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T24` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T25` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T26` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T27` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T28` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T29` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T30` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -55,7 +56,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: T20[] }` +#### 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: T20 }` +#### Update agent printer — `PATCH /agentprinter/{id}` +- Params: `id: int, body: { enabled?: bool, sort?: int }` +- Returns: `200 { agentprinter: T20 }` ### Section: /article @@ -70,7 +89,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: T21, 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 +161,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 +173,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` @@ -175,10 +194,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T21[] }` +- Returns: `200 { values: T22[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T21 }` +- Returns: `201 { attributevalue: T22 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -196,10 +215,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: T22 }` #### 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: T26[] } }` ### Section: /brand @@ -208,7 +227,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: T26[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -217,16 +236,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: T26[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T24[] }` +- Returns: `200 { carriers: T25[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T24 }` +- Returns: `201 { carrier: T25 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -235,10 +254,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T24 }` +- Returns: `200 { carrier: T25 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T24 }` +- Returns: `200 { carrier: T25 }` ### Section: /category @@ -331,7 +350,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?: T29 }[], 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,7 +368,7 @@ _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 @@ -376,16 +395,16 @@ _none_ - Returns: `200 { address: T9 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T26[] }` +- Returns: `200 { contacts: T27[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T26 }` +- Returns: `201 { contact: T27 }` #### 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: T27 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` @@ -409,19 +428,19 @@ _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 }` +- 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 }` +- 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 }` +- Returns: `200 { labeltemplate: T6 }` ### Section: /ledger @@ -469,13 +488,13 @@ _none_ - Returns: `204 void` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T23[] }` +- Returns: `200 { payments: T24[] }` #### 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: T24 }` #### 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[] }` @@ -512,6 +531,9 @@ _none_ #### 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` @@ -524,30 +546,33 @@ _none_ #### 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 }` +#### 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: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T22[] }` +- Returns: `200 { propertynames: T23[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T22 }` +- Returns: `201 { propertyname: T23 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -556,7 +581,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: T23 }` ### Section: /quote @@ -583,7 +608,7 @@ _none_ - 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,7 +677,7 @@ _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[] }` @@ -715,22 +740,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T27[] }` +- Returns: `200 { suppliers: T28[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T27 }` +- Returns: `201 { supplier: T28 }` #### 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: T28 }` #### 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?: T30|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?: T30|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit @@ -739,10 +764,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T20[] }` +- Returns: `200 { units: T21[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T20 }` +- Returns: `200 { unit: T21 }` ### Section: /v1 diff --git a/docs/api/routes/agent/state.md b/docs/api/routes/agent/state.md index 3d86425..811e3a1 100644 --- a/docs/api/routes/agent/state.md +++ b/docs/api/routes/agent/state.md @@ -33,13 +33,11 @@ State recorded "token": "…", "pairingpin": "…", "pairedAt": "…", - "clientserial": "…", - "clientmodel": "…", - "clientstate": "…", "agentversion": "…", "lastseenAt": "…", "updatedAt": "…", - "sort": 1 + "sort": 1, + "enabled": true } } ``` diff --git a/docs/api/routes/agentprinter.md b/docs/api/routes/agentprinter.md new file mode 100644 index 0000000..ac4d2c2 --- /dev/null +++ b/docs/api/routes/agentprinter.md @@ -0,0 +1,46 @@ +# `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 + } + ] +} +``` + +## 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`._ diff --git a/docs/api/routes/agentprinter/_id.delete.md b/docs/api/routes/agentprinter/_id.delete.md new file mode 100644 index 0000000..3828221 --- /dev/null +++ b/docs/api/routes/agentprinter/_id.delete.md @@ -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`._ diff --git a/docs/api/routes/agentprinter/_id.get.md b/docs/api/routes/agentprinter/_id.get.md new file mode 100644 index 0000000..495584e --- /dev/null +++ b/docs/api/routes/agentprinter/_id.get.md @@ -0,0 +1,43 @@ +# `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 + } +} +``` + +## 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`._ diff --git a/docs/api/routes/agentprinter/_id.patch.md b/docs/api/routes/agentprinter/_id.patch.md new file mode 100644 index 0000000..670f5f3 --- /dev/null +++ b/docs/api/routes/agentprinter/_id.patch.md @@ -0,0 +1,62 @@ +# `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 + } +} +``` + +## 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`._ diff --git a/docs/api/routes/agentprinter/order.md b/docs/api/routes/agentprinter/order.md new file mode 100644 index 0000000..df351b9 --- /dev/null +++ b/docs/api/routes/agentprinter/order.md @@ -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`._ diff --git a/docs/api/routes/events.md b/docs/api/routes/events.md index d6fffc4..eaf3350 100644 --- a/docs/api/routes/events.md +++ b/docs/api/routes/events.md @@ -46,6 +46,8 @@ 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` | `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, new printer discovery | | `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}` | diff --git a/docs/api/routes/printer/_id/state.md b/docs/api/routes/printer/_id/state.md new file mode 100644 index 0000000..6a9ac1b --- /dev/null +++ b/docs/api/routes/printer/_id/state.md @@ -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`._ diff --git a/docs/api/routes/printer/state.md b/docs/api/routes/printer/state.md new file mode 100644 index 0000000..ea9355c --- /dev/null +++ b/docs/api/routes/printer/state.md @@ -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`._ diff --git a/docs/api/routes/printeragent.get.md b/docs/api/routes/printeragent.get.md index b0442d8..8f4a4ed 100644 --- a/docs/api/routes/printeragent.get.md +++ b/docs/api/routes/printeragent.get.md @@ -20,13 +20,11 @@ Printer agent list "token": "…", "pairingpin": "…", "pairedAt": "…", - "clientserial": "…", - "clientmodel": "…", - "clientstate": "…", "agentversion": "…", "lastseenAt": "…", "updatedAt": "…", - "sort": 1 + "sort": 1, + "enabled": true } ] } diff --git a/docs/api/routes/printeragent.put.md b/docs/api/routes/printeragent.put.md index c0ac604..a2269af 100644 --- a/docs/api/routes/printeragent.put.md +++ b/docs/api/routes/printeragent.put.md @@ -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 } } ``` diff --git a/docs/api/routes/printeragent/_id.patch.md b/docs/api/routes/printeragent/_id.patch.md index 4463644..d234c43 100644 --- a/docs/api/routes/printeragent/_id.patch.md +++ b/docs/api/routes/printeragent/_id.patch.md @@ -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 } } ``` diff --git a/src/api/agent/index.js b/src/api/agent/index.js index ad6eeab..916f685 100644 --- a/src/api/agent/index.js +++ b/src/api/agent/index.js @@ -1,8 +1,22 @@ import express from 'express'; import crypto from 'node:crypto'; import * as db from '../../db/printeragent.js'; +import * as agentprinterDb from '../../db/agentprinter.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(); @@ -233,6 +247,15 @@ 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'); + } + res.write(`event: connected\ndata: ${JSON.stringify({ agentId: req.agent.id, name: req.agent.name })}\n\n`); const keepAlive = setInterval(() => { @@ -241,8 +264,17 @@ 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); + 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 +319,79 @@ 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); + } + + 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, + }); +}); diff --git a/src/api/agent/stateStore.js b/src/api/agent/stateStore.js new file mode 100644 index 0000000..59a4920 --- /dev/null +++ b/src/api/agent/stateStore.js @@ -0,0 +1,75 @@ +/** + * In-memory state store for connected printer agents. + * Keeps transient agent telemetry out of the database. + */ + +/** @type {Map} */ +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; +} + diff --git a/src/api/openapi.js b/src/api/openapi.js index 42b3191..c5ad55c 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -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,33 @@ * 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 * LabelObject: * type: object * required: [id, type, x, y] diff --git a/src/api/openapiSpec.js b/src/api/openapiSpec.js index cd161fb..3de9941 100644 --- a/src/api/openapiSpec.js +++ b/src/api/openapiSpec.js @@ -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' }, diff --git a/src/api/routes/agentprinter.js b/src/api/routes/agentprinter.js new file mode 100644 index 0000000..1aab69a --- /dev/null +++ b/src/api/routes/agentprinter.js @@ -0,0 +1,410 @@ +import * as db from '../../db/agentprinter.js'; +import { emit } from '../sse.js'; + +// #region Helpers + +function requireSelectedCompany(req) { + const companyId = req.user?.selectedCompanyId; + if (companyId == null) { + return { error: 'No company selected' }; + } + return { companyId }; +} + +function parsePositiveInt(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); + res.status(200).json({ agentprinters }); + } 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: [printeragentId, agentprinterIds] + * properties: + * printeragentId: + * type: integer + * 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 }); + } 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 }); + } 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 +} + diff --git a/src/api/routes/company.js b/src/api/routes/company.js index 1b20860..ce10f87 100644 --- a/src/api/routes/company.js +++ b/src/api/routes/company.js @@ -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); diff --git a/src/api/routes/events.js b/src/api/routes/events.js index a5a48c5..62820ea 100644 --- a/src/api/routes/events.js +++ b/src/api/routes/events.js @@ -55,6 +55,8 @@ 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` | `{}` | `PATCH /agentprinter/{id}`, `PUT /agentprinter/order`, `DELETE /agentprinter/{id}`, new printer discovery | * | `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}` | diff --git a/src/api/routes/printer.js b/src/api/routes/printer.js index ce5d8e3..1f5289c 100644 --- a/src/api/routes/printer.js +++ b/src/api/routes/printer.js @@ -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: diff --git a/src/api/routes/printeragent.js b/src/api/routes/printeragent.js index b424954..2d885bb 100644 --- a/src/api/routes/printeragent.js +++ b/src/api/routes/printeragent.js @@ -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); diff --git a/src/db/agentprinter.js b/src/db/agentprinter.js new file mode 100644 index 0000000..714865a --- /dev/null +++ b/src/db/agentprinter.js @@ -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); +} + diff --git a/src/services/companyPrinterService.js b/src/services/companyPrinterService.js new file mode 100644 index 0000000..713d0dd --- /dev/null +++ b/src/services/companyPrinterService.js @@ -0,0 +1,171 @@ +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>> + * + * @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>} */ +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} 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) => ({ + ...p, + agentId: aId, + agentName: agentName || null, + updatedAt: now, + })); + + 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 both `printer` (with data `{ printers }`) and `printerstate`. + * + * @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('printer', { companyId: cId, data: payload }); + emit('printerstate', { companyId: cId, data: payload }); +} + +/** + * 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, []); + } +} + diff --git a/src/util/logger.js b/src/util/logger.js index b1083a2..64d46d4 100644 --- a/src/util/logger.js +++ b/src/util/logger.js @@ -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 }; /**