u
This commit is contained in:
5
API.md
5
API.md
@@ -407,8 +407,13 @@ The store is exposed as a `LibDashStore` instance (see `src/index.js`). Each met
|
|||||||
- [printeragent](API.printeragent.md)
|
- [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}>`
|
- `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>`
|
- `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}>>`
|
- `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}>`
|
- `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)
|
- [retoure](API.retoure.md)
|
||||||
- `create(googleAuthId: number, body: {number?: string, date: string, entityId?: number, externalNumber?: string, lines?: Array<object>}, tx?: object): Promise<object>`
|
- `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>`
|
- `createShipment(googleAuthId: number, retoureId: number, input: object, tx?: object): Promise<object>`
|
||||||
|
|||||||
@@ -61,6 +61,52 @@ Deletes a printer agent of the user's selected company.
|
|||||||
await store.printeragent.delete(42, 5);
|
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`
|
## `printeragent.list`
|
||||||
|
|
||||||
*Source: `src/store/printeragent/list.js`*
|
*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 }]
|
// => [{ 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`
|
## `printeragent.update`
|
||||||
|
|
||||||
*Source: `src/store/printeragent/update.js`*
|
*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
|
```js
|
||||||
const agent = await store.printeragent.update(42, { id: 5, name: 'Kitchen printer', sort: 1 });
|
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}>`
|
||||||
|
|||||||
@@ -18,29 +18,64 @@ try {
|
|||||||
assert.deepEqual(await store.printeragent.list(googleAuthId), []);
|
assert.deepEqual(await store.printeragent.list(googleAuthId), []);
|
||||||
await assert.rejects(store.printeragent.create(googleAuthId, { name: ' ', pairingpin: '1' }), /Invalid printeragent/);
|
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.name, 'Bar');
|
||||||
assert.equal(a.pairingpin, '123456');
|
assert.equal(a.pairingpin, '123456');
|
||||||
assert.equal(a.token, null);
|
assert.equal(a.token, null);
|
||||||
|
assert.equal(a.sort, 5);
|
||||||
assert.equal(a.companyId, company.id);
|
assert.equal(a.companyId, company.id);
|
||||||
assert.ok(a.updatedAt);
|
assert.ok(a.updatedAt);
|
||||||
|
|
||||||
assert.equal(a.sort, 0);
|
// findByPairingpin
|
||||||
const s1 = await store.printeragent.update(googleAuthId, { id: a.id, sort: 5 });
|
const foundByPin = await store.printeragent.findByPairingpin('123456');
|
||||||
assert.equal(s1.sort, 5);
|
assert.equal(foundByPin.id, a.id);
|
||||||
assert.equal(s1.name, 'Bar');
|
assert.equal(await store.printeragent.findByPairingpin('999999'), null);
|
||||||
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/);
|
|
||||||
|
|
||||||
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 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), []);
|
assert.deepEqual(await store.printeragent.list(googleAuthId), []);
|
||||||
console.log('printeragent OK');
|
console.log('printeragent full test OK');
|
||||||
} finally {
|
} finally {
|
||||||
await provider.close?.();
|
await provider.close?.();
|
||||||
rmSync(tempDir, { recursive: true, force: true });
|
rmSync(tempDir, { recursive: true, force: true });
|
||||||
|
|||||||
@@ -24,3 +24,4 @@ export default function findByPairingpin(provider) {
|
|||||||
return result.rows[0] ? shape(result.rows[0]) : null;
|
return result.rows[0] ? shape(result.rows[0]) : null;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -25,3 +25,4 @@ export default function findByToken(provider) {
|
|||||||
return result.rows[0] ? shape(result.rows[0]) : null;
|
return result.rows[0] ? shape(result.rows[0]) : null;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -59,3 +59,4 @@ export default function pair(provider) {
|
|||||||
return shape(updated.rows[0]);
|
return shape(updated.rows[0]);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -37,3 +37,4 @@ export default function touchLastseen(provider) {
|
|||||||
return { id: numericId };
|
return { id: numericId };
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -43,3 +43,4 @@ export default function updateState(provider) {
|
|||||||
return shape(updated.rows[0]);
|
return shape(updated.rows[0]);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user