Compare commits

...

2 Commits

Author SHA1 Message Date
seb
c7d1b1a5d2 u 2026-10-30 18:09:33 +01:00
seb
745d0d0077 u 2026-10-30 18:06:03 +01:00
11 changed files with 434 additions and 14 deletions

5
API.md
View File

@@ -407,8 +407,13 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
- [printeragent](API.printeragent.md)
- `create(googleAuthId: number, input: {name: string, pairingpin: string, sort?: number}, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`
- `delete(googleAuthId: number, id: number, tx?: object): Promise<void>`
- `findByPairingpin(pairingpin: string, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>`
- `findByToken(token: string, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>`
- `list(googleAuthId: number, tx?: object): Promise<Array<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>>`
- `pair(id: number, input: {token: string, clientserial?: string, clientmodel?: string, agentversion?: string, pairedAt?: string}, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`
- `touchLastseen(id: number, agentversion?: string|null, tx?: object): Promise<{id: number}>`
- `update(googleAuthId: number, input: {id: number, name?: string, sort?: number}, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`
- `updateState(id: number, clientstate: string|null, tx?: object): Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`
- [retoure](API.retoure.md)
- `create(googleAuthId: number, body: {number?: string, date: string, entityId?: number, externalNumber?: string, lines?: Array<object>}, tx?: object): Promise<object>`
- `createShipment(googleAuthId: number, retoureId: number, input: object, tx?: object): Promise<object>`

View File

@@ -61,6 +61,52 @@ Deletes a printer agent of the user's selected company.
await store.printeragent.delete(42, 5);
```
## `printeragent.findByPairingpin`
*Source: `src/store/printeragent/findByPairingpin.js`*
Finds a printer agent by its pairing pin.
**Parameters**
| Name | Type | Description |
| --- | --- | --- |
| `pairingpin` | `string` | The pairing pin to search for. |
| `[tx]` | `object` | Optional transaction to run within. |
**Returns**
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>` — The printer agent, or null if not found.
**Example**
```js
const agent = await store.printeragent.findByPairingpin('123456');
```
## `printeragent.findByToken`
*Source: `src/store/printeragent/findByToken.js`*
Finds a printer agent by its authentication token.
**Parameters**
| Name | Type | Description |
| --- | --- | --- |
| `token` | `string` | The auth token to search for. |
| `[tx]` | `object` | Optional transaction to run within. |
**Returns**
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>` — The printer agent, or null if not found.
**Example**
```js
const agent = await store.printeragent.findByToken('abc...');
```
## `printeragent.list`
*Source: `src/store/printeragent/list.js`*
@@ -85,6 +131,47 @@ const agents = await store.printeragent.list(42);
// => [{ id, companyId, name, token, pairingpin, pairedAt, clientserial, clientmodel, clientstate, agentversion, lastseenAt, updatedAt, sort }]
```
## `printeragent.pair`
*Source: `src/store/printeragent/pair.js`*
Completes device pairing for a printer agent.
**Parameters**
| Name | Type | Description |
| --- | --- | --- |
| `id` | `number` | The printer agent id. |
| `input` | `object` | |
| `input.token` | `string` | Auth token for the paired device. |
| `[input.clientserial]` | `string` | Device serial identifier. |
| `[input.clientmodel]` | `string` | Device model name. |
| `[input.agentversion]` | `string` | Device agent software version. |
| `[input.pairedAt]` | `string` | Timestamp when paired. |
| `[tx]` | `object` | Optional transaction to run within. |
**Returns**
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`
## `printeragent.touchLastseen`
*Source: `src/store/printeragent/touchLastseen.js`*
Updates lastseen_at (and optionally agentversion) for a printer agent.
**Parameters**
| Name | Type | Description |
| --- | --- | --- |
| `id` | `number` | The printer agent id. |
| `[agentversion]` | `string|null` | Optional agent version to update. |
| `[tx]` | `object` | Optional transaction to run within. |
**Returns**
`Promise<{id: number}>`
## `printeragent.update`
*Source: `src/store/printeragent/update.js`*
@@ -115,3 +202,21 @@ Updates name and/or sort of a printer agent of the user's selected company.
```js
const agent = await store.printeragent.update(42, { id: 5, name: 'Kitchen printer', sort: 1 });
```
## `printeragent.updateState`
*Source: `src/store/printeragent/updateState.js`*
Updates the client state of a printer agent.
**Parameters**
| Name | Type | Description |
| --- | --- | --- |
| `id` | `number` | The printer agent id. |
| `clientstate` | `string|null` | The state payload/string. |
| `[tx]` | `object` | Optional transaction to run within. |
**Returns**
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>`

View File

@@ -18,29 +18,64 @@ try {
assert.deepEqual(await store.printeragent.list(googleAuthId), []);
await assert.rejects(store.printeragent.create(googleAuthId, { name: ' ', pairingpin: '1' }), /Invalid printeragent/);
const a = await store.printeragent.create(googleAuthId, { name: ' Bar ', pairingpin: '123456' });
const a = await store.printeragent.create(googleAuthId, { name: ' Bar ', pairingpin: '123456', sort: 5 });
assert.equal(a.name, 'Bar');
assert.equal(a.pairingpin, '123456');
assert.equal(a.token, null);
assert.equal(a.sort, 5);
assert.equal(a.companyId, company.id);
assert.ok(a.updatedAt);
assert.equal(a.sort, 0);
const s1 = await store.printeragent.update(googleAuthId, { id: a.id, sort: 5 });
assert.equal(s1.sort, 5);
assert.equal(s1.name, 'Bar');
await assert.rejects(store.printeragent.update(googleAuthId, { id: a.id }), /Invalid printeragent/);
await assert.rejects(store.printeragent.update(googleAuthId, { id: a.id, sort: 1.5 }), /Invalid printeragent/);
const b = await store.printeragent.update(googleAuthId, { id: a.id, name: 'Kitchen' });
assert.equal(b.name, 'Kitchen');
await assert.rejects(store.printeragent.update(googleAuthId, { id: 9999, name: 'x' }), /Printeragent not found/);
await assert.rejects(store.printeragent.update(googleAuthId, { id: a.id, name: '' }), /Invalid printeragent/);
// findByPairingpin
const foundByPin = await store.printeragent.findByPairingpin('123456');
assert.equal(foundByPin.id, a.id);
assert.equal(await store.printeragent.findByPairingpin('999999'), null);
assert.equal((await store.printeragent.list(googleAuthId)).length, 1);
// pair
const paired = await store.printeragent.pair(a.id, {
token: 'test-token-123',
clientserial: 'SN12345',
clientmodel: 'Epson TM-T88VI',
agentversion: '1.0.0',
});
assert.equal(paired.token, 'test-token-123');
assert.equal(paired.clientserial, 'SN12345');
assert.equal(paired.clientmodel, 'Epson TM-T88VI');
assert.equal(paired.agentversion, '1.0.0');
assert.equal(paired.pairingpin, null);
assert.ok(paired.pairedAt);
// findByToken
const foundByToken = await store.printeragent.findByToken('test-token-123');
assert.equal(foundByToken.id, a.id);
assert.equal(foundByToken.clientmodel, 'Epson TM-T88VI');
assert.equal(await store.printeragent.findByToken('invalid-token'), null);
// updateState
const withState = await store.printeragent.updateState(a.id, { online: true, paper: 'ok' });
assert.equal(withState.clientstate, JSON.stringify({ online: true, paper: 'ok' }));
// touchLastseen
await store.printeragent.touchLastseen(a.id, '1.0.1');
const afterTouch = await store.printeragent.findByToken('test-token-123');
assert.equal(afterTouch.agentversion, '1.0.1');
// update name and sort
const b = await store.printeragent.update(googleAuthId, { id: a.id, name: 'Kitchen', sort: 1 });
assert.equal(b.name, 'Kitchen');
assert.equal(b.sort, 1);
// list
const list = await store.printeragent.list(googleAuthId);
assert.equal(list.length, 1);
assert.equal(list[0].name, 'Kitchen');
assert.equal(list[0].sort, 1);
// delete
await store.printeragent.delete(googleAuthId, a.id);
await assert.rejects(store.printeragent.delete(googleAuthId, a.id), /Printeragent not found/);
assert.equal(await store.printeragent.findByToken('test-token-123'), null);
assert.deepEqual(await store.printeragent.list(googleAuthId), []);
console.log('printeragent OK');
console.log('printeragent full test OK');
} finally {
await provider.close?.();
rmSync(tempDir, { recursive: true, force: true });

View File

@@ -204,6 +204,11 @@ import printeragentList from './store/printeragent/list.js';
import printeragentCreate from './store/printeragent/create.js';
import printeragentUpdate from './store/printeragent/update.js';
import printeragentDelete from './store/printeragent/delete.js';
import printeragentFindByPairingpin from './store/printeragent/findByPairingpin.js';
import printeragentFindByToken from './store/printeragent/findByToken.js';
import printeragentPair from './store/printeragent/pair.js';
import printeragentUpdateState from './store/printeragent/updateState.js';
import printeragentTouchLastseen from './store/printeragent/touchLastseen.js';
import modelconversationCreate from './store/modelconversation/create.js';
import modelconversationGet from './store/modelconversation/get.js';
import modelconversationList from './store/modelconversation/list.js';
@@ -646,6 +651,11 @@ export default class LibDashStore {
create: printeragentCreate(provider),
update: printeragentUpdate(provider),
delete: printeragentDelete(provider),
findByPairingpin: printeragentFindByPairingpin(provider),
findByToken: printeragentFindByToken(provider),
pair: printeragentPair(provider),
updateState: printeragentUpdateState(provider),
touchLastseen: printeragentTouchLastseen(provider),
};
this.modelconversation = {

View File

@@ -29,6 +29,61 @@ FROM printeragent
WHERE id = @id AND company_id = @companyId
`;
export const GET_BY_ID = `
SELECT
${PRINTERAGENT_COLUMNS}
FROM printeragent
WHERE id = @id
`;
export const FIND_BY_PAIRINGPIN = `
SELECT
${PRINTERAGENT_COLUMNS}
FROM printeragent
WHERE pairingpin = @pairingpin
`;
export const FIND_BY_TOKEN = `
SELECT
${PRINTERAGENT_COLUMNS}
FROM printeragent
WHERE token = @token
`;
export const PAIR = `
UPDATE printeragent
SET token = @token,
pairingpin = NULL,
paired_at = @pairedAt,
clientserial = @clientserial,
clientmodel = @clientmodel,
agentversion = @agentversion,
lastseen_at = SYSUTCDATETIME(),
updated_at = SYSUTCDATETIME()
WHERE id = @id
`;
export const UPDATE_STATE = `
UPDATE printeragent
SET clientstate = @clientstate,
lastseen_at = SYSUTCDATETIME(),
updated_at = SYSUTCDATETIME()
WHERE id = @id
`;
export const TOUCH_LASTSEEN = `
UPDATE printeragent
SET lastseen_at = SYSUTCDATETIME()
WHERE id = @id
`;
export const TOUCH_LASTSEEN_AND_VERSION = `
UPDATE printeragent
SET lastseen_at = SYSUTCDATETIME(),
agentversion = @agentversion
WHERE id = @id
`;
export const CREATE = `
INSERT INTO printeragent (company_id, name, pairingpin, sort)
OUTPUT

View File

@@ -5,8 +5,15 @@ const queries = translateQueries(source, 'printeragent');
export const {
CREATE,
DELETE_BY_COMPANY_AND_ID,
FIND_BY_PAIRINGPIN,
FIND_BY_TOKEN,
GET_BY_COMPANY_AND_ID,
GET_BY_ID,
LIST_BY_COMPANY,
PAIR,
PRINTERAGENT_COLUMNS,
TOUCH_LASTSEEN,
TOUCH_LASTSEEN_AND_VERSION,
UPDATE,
UPDATE_STATE,
} = queries;

View File

@@ -0,0 +1,27 @@
import { FIND_BY_PAIRINGPIN as MSSQL_FIND } from '../../providers/mssql/queries/printeragent.js';
import { FIND_BY_PAIRINGPIN as SQLITE_FIND } from '../../providers/sqlite3/queries/printeragent.js';
import makeRunner from '../runner.js';
import { shape } from './_shared.js';
export default function findByPairingpin(provider) {
const sql = provider?.dialect === 'sqlite3' ? SQLITE_FIND : MSSQL_FIND;
/**
* Finds a printer agent by its pairing pin.
*
* @param {string} pairingpin - The pairing pin to search for.
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>} The printer agent, or null if not found.
*
* @example
* const agent = await store.printeragent.findByPairingpin('123456');
*/
return async (pairingpin, tx) => {
if (!pairingpin) return null;
const result = await makeRunner(provider, tx).query(sql, {
pairingpin: String(pairingpin).trim(),
});
return result.rows[0] ? shape(result.rows[0]) : null;
};
}

View File

@@ -0,0 +1,28 @@
import { FIND_BY_TOKEN as MSSQL_FIND } from '../../providers/mssql/queries/printeragent.js';
import { FIND_BY_TOKEN as SQLITE_FIND } from '../../providers/sqlite3/queries/printeragent.js';
import makeRunner from '../runner.js';
import { shape } from './_shared.js';
export default function findByToken(provider) {
const sql = provider?.dialect === 'sqlite3' ? SQLITE_FIND : MSSQL_FIND;
/**
* Finds a printer agent by its authentication token.
*
* @param {string} token - The auth token to search for.
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}|null>} The printer agent, or null if not found.
*
* @example
* const agent = await store.printeragent.findByToken('abc...');
*/
return async (token, tx) => {
const trimmed = String(token ?? '').trim();
if (!trimmed) return null;
const result = await makeRunner(provider, tx).query(sql, {
token: trimmed,
});
return result.rows[0] ? shape(result.rows[0]) : null;
};
}

View File

@@ -0,0 +1,62 @@
import {
PAIR as MSSQL_PAIR,
GET_BY_ID as MSSQL_GET,
} from '../../providers/mssql/queries/printeragent.js';
import {
PAIR as SQLITE_PAIR,
GET_BY_ID as SQLITE_GET,
} from '../../providers/sqlite3/queries/printeragent.js';
import makeRunner from '../runner.js';
import { shape } from './_shared.js';
export default function pair(provider) {
const isSqlite = provider?.dialect === 'sqlite3';
const pairSql = isSqlite ? SQLITE_PAIR : MSSQL_PAIR;
const getSql = isSqlite ? SQLITE_GET : MSSQL_GET;
/**
* Completes device pairing for a printer agent.
*
* @param {number} id - The printer agent id.
* @param {object} input
* @param {string} input.token - Auth token for the paired device.
* @param {string} [input.clientserial] - Device serial identifier.
* @param {string} [input.clientmodel] - Device model name.
* @param {string} [input.agentversion] - Device agent software version.
* @param {string} [input.pairedAt] - Timestamp when paired.
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>}
*/
return async (id, input = {}, tx) => {
const numericId = Number(id);
if (!Number.isInteger(numericId) || numericId <= 0) {
throw new Error('Printeragent not found');
}
const token = typeof input.token === 'string' ? input.token.trim() : '';
if (!token) {
throw new Error('Invalid printeragent');
}
const clientserial = input.clientserial ? String(input.clientserial).trim() : null;
const clientmodel = input.clientmodel ? String(input.clientmodel).trim() : null;
const agentversion = input.agentversion ? String(input.agentversion).trim() : null;
const pairedAt = input.pairedAt ?? new Date().toISOString();
const runner = makeRunner(provider, tx);
await runner.query(pairSql, {
id: numericId,
token,
pairedAt,
clientserial,
clientmodel,
agentversion,
});
const updated = await runner.query(getSql, { id: numericId });
if (!updated.rows[0]) {
throw new Error('Printeragent not found');
}
return shape(updated.rows[0]);
};
}

View File

@@ -0,0 +1,40 @@
import {
TOUCH_LASTSEEN as MSSQL_TOUCH,
TOUCH_LASTSEEN_AND_VERSION as MSSQL_TOUCH_VERSION,
} from '../../providers/mssql/queries/printeragent.js';
import {
TOUCH_LASTSEEN as SQLITE_TOUCH,
TOUCH_LASTSEEN_AND_VERSION as SQLITE_TOUCH_VERSION,
} from '../../providers/sqlite3/queries/printeragent.js';
import makeRunner from '../runner.js';
export default function touchLastseen(provider) {
const isSqlite = provider?.dialect === 'sqlite3';
const touchSql = isSqlite ? SQLITE_TOUCH : MSSQL_TOUCH;
const touchVersionSql = isSqlite ? SQLITE_TOUCH_VERSION : MSSQL_TOUCH_VERSION;
/**
* Updates lastseen_at (and optionally agentversion) for a printer agent.
*
* @param {number} id - The printer agent id.
* @param {string|null} [agentversion] - Optional agent version to update.
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<{id: number}>}
*/
return async (id, agentversion, tx) => {
const numericId = Number(id);
if (!Number.isInteger(numericId) || numericId <= 0) {
throw new Error('Printeragent not found');
}
const runner = makeRunner(provider, tx);
const versionVal = agentversion ? String(agentversion).trim() : null;
if (versionVal) {
await runner.query(touchVersionSql, { id: numericId, agentversion: versionVal });
} else {
await runner.query(touchSql, { id: numericId });
}
return { id: numericId };
};
}

View File

@@ -0,0 +1,46 @@
import {
UPDATE_STATE as MSSQL_UPDATE_STATE,
GET_BY_ID as MSSQL_GET,
} from '../../providers/mssql/queries/printeragent.js';
import {
UPDATE_STATE as SQLITE_UPDATE_STATE,
GET_BY_ID as SQLITE_GET,
} from '../../providers/sqlite3/queries/printeragent.js';
import makeRunner from '../runner.js';
import { shape } from './_shared.js';
export default function updateState(provider) {
const isSqlite = provider?.dialect === 'sqlite3';
const updateSql = isSqlite ? SQLITE_UPDATE_STATE : MSSQL_UPDATE_STATE;
const getSql = isSqlite ? SQLITE_GET : MSSQL_GET;
/**
* Updates the client state of a printer agent.
*
* @param {number} id - The printer agent id.
* @param {string|null} clientstate - The state payload/string.
* @param {object} [tx] - Optional transaction to run within.
* @returns {Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, clientmodel: string|null, clientstate: string|null, agentversion: string|null, lastseenAt: string|null, updatedAt: string, sort: number}>}
*/
return async (id, clientstate, tx) => {
const numericId = Number(id);
if (!Number.isInteger(numericId) || numericId <= 0) {
throw new Error('Printeragent not found');
}
const stateVal = clientstate == null ? null : (typeof clientstate === 'string' ? clientstate.trim() : JSON.stringify(clientstate));
const runner = makeRunner(provider, tx);
await runner.query(updateSql, {
id: numericId,
clientstate: stateVal,
});
const updated = await runner.query(getSql, { id: numericId });
if (!updated.rows[0]) {
throw new Error('Printeragent not found');
}
return shape(updated.rows[0]);
};
}