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

u

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

10
docs/api/README.md
View File

@@ -48,6 +48,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
| [`routes/article/supplier/order.md`](routes/article/supplier/order.md) | `PUT /article/{sku}/supplier/order` |
| [`routes/article/supplier/delete.md`](routes/article/supplier/delete.md) | `DELETE /article/{sku}/supplier/{id}` |
| [`routes/article/supplier/update.md`](routes/article/supplier/update.md) | `PATCH /article/{sku}/supplier/{id}` |
| [`routes/article/:sku/track_stock.md`](routes/article/:sku/track_stock.md) | `PUT /article/{sku}/track_stock` |
| [`routes/article/set-weight.md`](routes/article/set-weight.md) | `PUT /article/{sku}/weight` |
| [`routes/articleIndex.md`](routes/articleIndex.md) | `GET /articleIndex` |
| [`routes/auth/login.md`](routes/auth/login.md) | `POST /auth/login` |
@@ -145,6 +146,13 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
| [`routes/unit/delete.md`](routes/unit/delete.md) | `DELETE /unit` |
| [`routes/unit/list.md`](routes/unit/list.md) | `GET /unit` |
| [`routes/unit/upsert.md`](routes/unit/upsert.md) | `PUT /unit` |
| [`routes/warehouse/list.md`](routes/warehouse/list.md) | `GET /warehouse` |
| [`routes/warehouse/create.md`](routes/warehouse/create.md) | `POST /warehouse` |
| [`routes/warehouse/order.md`](routes/warehouse/order.md) | `PUT /warehouse/order` |
| [`routes/warehouse/delete.md`](routes/warehouse/delete.md) | `DELETE /warehouse/{id}` |
| [`routes/warehouse/get.md`](routes/warehouse/get.md) | `GET /warehouse/{id}` |
| [`routes/warehouse/update.md`](routes/warehouse/update.md) | `PATCH /warehouse/{id}` |
| [`routes/warehouse/:id.put.md`](routes/warehouse/:id.put.md) | `PUT /warehouse/{id}` |
Machine-readable spec: [`openapi.json`](openapi.json).
@@ -154,7 +162,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A
| Signal | Emitted by |
|--------|------------|
| `article-<sku>` | `PUT /article/{sku}/brand`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/eans`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}`, `PUT /article/{sku}/images/order`, `PUT /article/{sku}/prices`, `POST /article/{sku}/supplier`, `PUT /article/{sku}/supplier/order`, `DELETE /article/{sku}/supplier/{id}`, `PATCH /article/{sku}/supplier/{id}`, `PUT /article/{sku}/weight` |
| `article-<sku>` | `PUT /article/{sku}/brand`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/eans`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}`, `PUT /article/{sku}/images/order`, `PUT /article/{sku}/prices`, `POST /article/{sku}/supplier`, `PUT /article/{sku}/supplier/order`, `DELETE /article/{sku}/supplier/{id}`, `PATCH /article/{sku}/supplier/{id}`, `PUT /article/{sku}/track_stock`, `PUT /article/{sku}/weight` |
| `articles` | `POST /article`, `DELETE /article/{sku}`, `PATCH /article/{sku}` |
| `category` | `POST /category`, `PUT /category/order`, `DELETE /category/{id}`, `PATCH /category/{id}`, `DELETE /category/{id}/image`, `POST /category/{id}/image` |

765
docs/api/openapi.json
View File

@@ -92,12 +92,610 @@
"name": "Stock",
"description": "Manual stock additions and removals"
},
{
"name": "Warehouse",
"description": "Company-scoped warehouses"
},
{
"name": "Serper",
"description": "Serper Google image search and thumbnail streaming"
}
],
"paths": {
"/warehouse": {
"get": {
"tags": [
"Warehouse"
],
"summary": "List warehouses",
"description": "Lists warehouses for the selected company, ordered by sort and name.",
"security": [
{
"cookieAuth": []
}
],
"x-markdown": "warehouse/list.md",
"responses": {
"200": {
"description": "List of warehouses",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
}
},
"400": {
"description": "No company selected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": [
"Warehouse"
],
"summary": "Create warehouse",
"description": "Creates a new warehouse for the selected company.\nSort order will be automatically appended if omitted.\n",
"security": [
{
"cookieAuth": []
}
],
"x-markdown": "warehouse/create.md",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseCreateInput"
}
}
}
},
"responses": {
"201": {
"description": "Created warehouse",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
},
"400": {
"description": "Invalid input or missing fields",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Warehouse already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/warehouse/order": {
"put": {
"tags": [
"Warehouse"
],
"summary": "Reorder warehouses",
"description": "Reorders warehouses for the selected company.\n`warehouseIds` must include all existing warehouse IDs exactly once.\n",
"security": [
{
"cookieAuth": []
}
],
"x-markdown": "warehouse/order.md",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"warehouseIds"
],
"properties": {
"warehouseIds": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Applied warehouse order",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouseIds": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
},
"400": {
"description": "Invalid warehouse order or no company selected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/warehouse/{id}": {
"get": {
"tags": [
"Warehouse"
],
"summary": "Get warehouse by ID",
"description": "Retrieves a single warehouse for the authenticated user's selected company.",
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "Warehouse ID"
}
],
"x-markdown": "warehouse/get.md",
"responses": {
"200": {
"description": "Warehouse details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
},
"400": {
"description": "Invalid ID or no company selected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Warehouse not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"patch": {
"tags": [
"Warehouse"
],
"summary": "Update warehouse (partial)",
"description": "Updates specified fields of an existing warehouse for the selected company.",
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "Warehouse ID"
}
],
"x-markdown": "warehouse/update.md",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseUpdateInput"
}
}
}
},
"responses": {
"200": {
"description": "Updated warehouse",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Warehouse not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Warehouse name conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"tags": [
"Warehouse"
],
"summary": "Update warehouse",
"description": "Updates specified fields of an existing warehouse for the selected company.",
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "Warehouse ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseUpdateInput"
}
}
}
},
"responses": {
"200": {
"description": "Updated warehouse",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Warehouse not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Warehouse name conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"delete": {
"tags": [
"Warehouse"
],
"summary": "Delete warehouse",
"description": "Deletes a warehouse if not in use in the ledger.",
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "Warehouse ID"
}
],
"x-markdown": "warehouse/delete.md",
"responses": {
"204": {
"description": "Warehouse deleted"
},
"400": {
"description": "Invalid ID or no company selected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Warehouse not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Warehouse in use in ledger",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/unit": {
"get": {
"tags": [
@@ -8995,6 +9593,10 @@
},
"name": {
"type": "string"
},
"track_stock": {
"type": "boolean",
"description": "Whether to track inventory stock (defaults to true)"
}
},
"example": {
@@ -9277,6 +9879,10 @@
"unitSi": {
"type": "string",
"description": "Existing company unit `si`"
},
"track_stock": {
"type": "boolean",
"description": "Whether to track inventory stock"
}
},
"example": {
@@ -10277,6 +10883,113 @@
}
}
},
"/article/{sku}/track_stock": {
"put": {
"tags": [
"Article"
],
"summary": "Set article track_stock flag by SKU",
"description": "Enables or disables inventory stock tracking for this article.\n",
"security": [
{
"cookieAuth": []
}
],
"x-signals": [
"article-<sku>"
],
"parameters": [
{
"in": "path",
"name": "sku",
"required": true,
"schema": {
"type": "string"
},
"description": "Article SKU"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"track_stock"
],
"properties": {
"track_stock": {
"type": "boolean",
"description": "Whether to track inventory stock for this article"
}
},
"example": {
"track_stock": true
}
}
}
}
},
"responses": {
"200": {
"description": "Updated article detail",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"article": {
"$ref": "#/components/schemas/ArticleDetail"
}
}
}
}
}
},
"400": {
"description": "Invalid track_stock",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Article not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/article/{sku}/categories": {
"put": {
"tags": [
@@ -10889,12 +11602,15 @@
},
"sku": {
"type": "string"
},
"track_stock": {
"type": "boolean"
}
}
},
"ArticleDetail": {
"type": "object",
"description": "Full article payload (unit, brand, categoryIds, photos, eans, prices, …)",
"description": "Full article payload (unit, brand, categoryIds, photos, eans, prices, track_stock, …)",
"additionalProperties": true
},
"ArticleHistoryEntry": {
@@ -12116,6 +12832,53 @@
}
}
},
"Warehouse": {
"type": "object",
"required": [
"id",
"name",
"sort"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sort": {
"type": "integer",
"description": "Sort order"
}
}
},
"WarehouseCreateInput": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"sort": {
"type": "integer",
"description": "Optional sort order (defaults to auto-increment)"
}
}
},
"WarehouseUpdateInput": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sort": {
"type": "integer",
"description": "Sort order"
}
}
},
"StockAdjustmentInput": {
"type": "object",
"properties": {

49
docs/api/routes/article/:sku/track_stock.md Normal file
View File

@@ -0,0 +1,49 @@
# `PUT /article/{sku}/track_stock`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Set article track_stock flag by SKU
Enables or disables inventory stock tracking for this article.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | Article SKU |
## Body (JSON)
```json
{
"track_stock": true
}
```
## Signals
On success, emits SSE signal: `article-<sku>` (see [`GET /events`](../events.md)).
## Response `200`
Updated article detail
```json
{
"article": {}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid track_stock — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Article not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

3
docs/api/routes/article/create.md
View File

@@ -29,7 +29,8 @@ Created
"id": 1,
"parentId": 1,
"name": "…",
"sku": "…"
"sku": "…",
"track_stock": true
}
}
```

50
docs/api/routes/warehouse/:id.put.md Normal file
View File

@@ -0,0 +1,50 @@
# `PUT /warehouse/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update warehouse
Updates specified fields of an existing warehouse for the selected company.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | Warehouse ID |
## Body (JSON)
```json
{
"name": "…",
"sort": 1
}
```
## Response `200`
Updated warehouse
```json
{
"warehouse": {
"id": 1,
"name": "…",
"sort": 1
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid input — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Warehouse not found — `{"error":"…"}` |
| 409 | Warehouse name conflict — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

45
docs/api/routes/warehouse/create.md Normal file
View File

@@ -0,0 +1,45 @@
# `POST /warehouse`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Create warehouse
Creates a new warehouse for the selected company.
Sort order will be automatically appended if omitted.
## Body (JSON)
```json
{
"name": "…",
"sort": 1
}
```
## Response `201`
Created warehouse
```json
{
"warehouse": {
"id": 1,
"name": "…",
"sort": 1
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid input or missing fields — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 409 | Warehouse already exists — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

33
docs/api/routes/warehouse/delete.md Normal file
View File

@@ -0,0 +1,33 @@
# `DELETE /warehouse/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Delete warehouse
Deletes a warehouse if not in use in the ledger.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | Warehouse ID |
## Response `204`
Warehouse deleted
_No content_
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Warehouse not found — `{"error":"…"}` |
| 409 | Warehouse in use in ledger — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

40
docs/api/routes/warehouse/get.md Normal file
View File

@@ -0,0 +1,40 @@
# `GET /warehouse/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Get warehouse by ID
Retrieves a single warehouse for the authenticated user's selected company.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | Warehouse ID |
## Response `200`
Warehouse details
```json
{
"warehouse": {
"id": 1,
"name": "…",
"sort": 1
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Warehouse not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

35
docs/api/routes/warehouse/list.md Normal file
View File

@@ -0,0 +1,35 @@
# `GET /warehouse`
Protected. Requires a valid session cookie (`credentials: 'include'`).
List warehouses
Lists warehouses for the selected company, ordered by sort and name.
## Response `200`
List of warehouses
```json
{
"warehouses": [
{
"id": 1,
"name": "…",
"sort": 1
}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | No company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

43
docs/api/routes/warehouse/order.md Normal file
View File

@@ -0,0 +1,43 @@
# `PUT /warehouse/order`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Reorder warehouses
Reorders warehouses for the selected company.
`warehouseIds` must include all existing warehouse IDs exactly once.
## Body (JSON)
```json
{
"warehouseIds": [
1
]
}
```
## Response `200`
Applied warehouse order
```json
{
"warehouseIds": [
1
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid warehouse order or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

50
docs/api/routes/warehouse/update.md Normal file
View File

@@ -0,0 +1,50 @@
# `PATCH /warehouse/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update warehouse (partial)
Updates specified fields of an existing warehouse for the selected company.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | Warehouse ID |
## Body (JSON)
```json
{
"name": "…",
"sort": 1
}
```
## Response `200`
Updated warehouse
```json
{
"warehouse": {
"id": 1,
"name": "…",
"sort": 1
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid input — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Warehouse not found — `{"error":"…"}` |
| 409 | Warehouse name conflict — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._