feat(manifest): add externalNumber reference to quote/order/delivery

- Add `external_number NVARCHAR(100)` column to the `manifest` table.
- Thread `externalNumber` through manifestDoc and delivery SQL (list,
  header, create, update).
- Include `externalNumber` in shapeSummary and quote/order/delivery
  create/update/list/getById handlers (optional, clearable on update).
- Update README type definitions and regenerate API/schema docs.
This commit is contained in:
seb
2026-08-08 09:13:20 +02:00
parent f302cda39e
commit 29099b2a16
23 changed files with 210 additions and 143 deletions

View File

@@ -537,6 +537,7 @@ BEGIN
[number] NVARCHAR(100) NOT NULL,
[type] NVARCHAR(100) NOT NULL,
entity_id INT NULL,
external_number NVARCHAR(100) NULL,
[date] DATETIME2 NOT NULL CONSTRAINT DF_manifest_date DEFAULT SYSUTCDATETIME(),
CONSTRAINT FK_manifest_company FOREIGN KEY (company_id) REFERENCES company(id) ON DELETE NO ACTION,
CONSTRAINT FK_manifest_entity FOREIGN KEY (entity_id) REFERENCES entity(id) ON DELETE SET NULL

View File

@@ -6,6 +6,7 @@ SELECT
m.[number],
m.[type],
m.entity_id AS supplierId,
m.external_number AS externalNumber,
m.[date]
FROM manifest m
WHERE m.company_id = @companyId
@@ -19,6 +20,7 @@ SELECT
m.[number],
m.[type],
m.entity_id AS supplierId,
m.external_number AS externalNumber,
m.[date]
FROM manifest m
WHERE m.id = @id
@@ -44,9 +46,9 @@ ORDER BY ma.id
`;
export const CREATE_MANIFEST = `
INSERT INTO manifest (company_id, [number], [type], entity_id, [date])
INSERT INTO manifest (company_id, [number], [type], entity_id, external_number, [date])
OUTPUT INSERTED.id
VALUES (@companyId, @number, @type, @entityId, @date)
VALUES (@companyId, @number, @type, @entityId, @externalNumber, @date)
`;
export const UPDATE_MANIFEST = `
@@ -54,6 +56,7 @@ UPDATE manifest
SET
[number] = @number,
entity_id = @entityId,
external_number = @externalNumber,
[date] = @date
WHERE id = @id
AND company_id = @companyId

View File

@@ -12,6 +12,7 @@ SELECT
m.[number],
m.[type],
m.entity_id AS entityId,
m.external_number AS externalNumber,
m.[date]
FROM manifest m
WHERE m.company_id = @companyId
@@ -25,6 +26,7 @@ SELECT
m.[number],
m.[type],
m.entity_id AS entityId,
m.external_number AS externalNumber,
m.[date]
FROM manifest m
WHERE m.id = @id
@@ -50,9 +52,9 @@ ORDER BY ma.id
`;
export const CREATE_MANIFEST = `
INSERT INTO manifest (company_id, [number], [type], entity_id, [date])
INSERT INTO manifest (company_id, [number], [type], entity_id, external_number, [date])
OUTPUT INSERTED.id
VALUES (@companyId, @number, @type, @entityId, @date)
VALUES (@companyId, @number, @type, @entityId, @externalNumber, @date)
`;
export const UPDATE_MANIFEST = `
@@ -60,6 +62,7 @@ UPDATE manifest
SET
[number] = @number,
entity_id = @entityId,
external_number = @externalNumber,
[date] = @date
WHERE id = @id
AND company_id = @companyId

View File

@@ -18,13 +18,14 @@ export default function create(pool) {
* @param {string} body.number - The delivery number.
* @param {string} body.date - The delivery date.
* @param {number} body.supplierId - The id of the supplier.
* @param {string} [body.externalNumber] - An external (supplier) reference number.
* @param {Array<object>} [body.lines] - The delivery lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, date: string, lines: Array<object>}>} The created delivery.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The created delivery.
* @throws {Error} If the delivery is invalid.
*
* @example
* const delivery = await store.delivery.create(42, { number: 'D-1', date: '2026-01-01', supplierId: 5, lines: [...] });
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, body = {}) => {
const number = body.number?.trim?.() ? body.number.trim() : null;
@@ -32,6 +33,9 @@ export default function create(pool) {
if (!number || !date) {
throw new Error('Invalid delivery');
}
const externalNumber = body.externalNumber?.trim?.()
? body.externalNumber.trim()
: null;
const lines = normalizeLines(body.lines ?? []);
@@ -53,6 +57,7 @@ export default function create(pool) {
.input('number', number)
.input('type', DELIVERY_TYPE)
.input('entityId', supplierId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(CREATE_MANIFEST);

View File

@@ -9,12 +9,12 @@ export default function getById(pool) {
*
* @param {number} googleAuthId - The id of the Google auth user.
* @param {number} id - The id of the delivery.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, date: string, lines: Array<object>}>} The delivery.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The delivery.
* @throws {Error} If the delivery is not found.
*
* @example
* const delivery = await store.delivery.getById(42, 5);
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, id) => {
if (!Number.isFinite(id)) {

View File

@@ -12,6 +12,7 @@ export function shapeSummary(row) {
number: row.number,
type: DELIVERY_TYPE,
supplierId: row.supplierId ?? null,
externalNumber: row.externalNumber ?? null,
date: row.date,
};
}

View File

@@ -9,11 +9,11 @@ export default function list(pool) {
* Lists the deliveries of the user's selected company.
*
* @param {number} googleAuthId - The id of the Google auth user.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number, date: string}>>} The deliveries.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string}>>} The deliveries.
*
* @example
* const deliveries = await store.delivery.list(42);
* // => [{ id, number, type, entityId, date }]
* // => [{ id, number, type, entityId, externalNumber, date }]
*/
return async (googleAuthId) => {
const { companyId } = await access(googleAuthId);

View File

@@ -24,8 +24,9 @@ export default function update(pool) {
* @param {string} [patch.number] - The new delivery number.
* @param {string} [patch.date] - The new delivery date.
* @param {number} [patch.supplierId] - The new supplier id.
* @param {string} [patch.externalNumber] - The new external (supplier) reference number.
* @param {Array<object>} [patch.lines] - The new delivery lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, date: string, lines: Array<object>}>} The updated delivery.
* @returns {Promise<{id: number, number: string, type: string, entityId: number, externalNumber: string|null, date: string, lines: Array<object>}>} The updated delivery.
* @throws {Error} If the delivery is not found.
*
* @example
@@ -43,9 +44,10 @@ export default function update(pool) {
patch,
'supplierId',
);
const hasExternalNumber = Object.prototype.hasOwnProperty.call(patch, 'externalNumber');
const hasLines = Object.prototype.hasOwnProperty.call(patch, 'lines');
if (!hasNumber && !hasDate && !hasSupplierId && !hasLines) {
if (!hasNumber && !hasDate && !hasSupplierId && !hasExternalNumber && !hasLines) {
throw new Error('Invalid delivery');
}
@@ -99,12 +101,20 @@ export default function update(pool) {
);
}
let externalNumber = summary.externalNumber;
if (hasExternalNumber) {
externalNumber = patch.externalNumber?.trim?.()
? patch.externalNumber.trim()
: null;
}
await request(pool, tx)
.input('id', id)
.input('companyId', companyId)
.input('type', DELIVERY_TYPE)
.input('number', number)
.input('entityId', supplierId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(UPDATE_MANIFEST);

View File

@@ -16,6 +16,7 @@ export function shapeSummary(type, row) {
number: row.number,
type,
entityId: row.entityId ?? null,
externalNumber: row.externalNumber ?? null,
date: row.date,
};
}

View File

@@ -17,13 +17,14 @@ export default function create(pool) {
* @param {string} body.number - The order number.
* @param {string} body.date - The order date.
* @param {number} [body.entityId] - The id of the customer entity.
* @param {string} [body.externalNumber] - An external (customer) reference number.
* @param {Array<object>} [body.lines] - The order lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The created order.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The created order.
* @throws {Error} If the order is invalid.
*
* @example
* const order = await store.order.create(42, { number: 'B-2026-001', date: '2026-09-15', entityId: 12, lines: [...] });
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, body = {}) => {
const number = body.number?.trim?.() ? body.number.trim() : null;
@@ -31,6 +32,9 @@ export default function create(pool) {
if (!number || !date) {
throw new Error('Invalid order');
}
const externalNumber = body.externalNumber?.trim?.()
? body.externalNumber.trim()
: null;
const lines = normalizeLines(body.lines ?? []);
const { companyId, rootCategoryId } = await access(googleAuthId);
@@ -51,6 +55,7 @@ export default function create(pool) {
.input('number', number)
.input('type', ORDER_TYPE)
.input('entityId', entityId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(CREATE_MANIFEST);

View File

@@ -10,12 +10,12 @@ export default function getById(pool) {
*
* @param {number} googleAuthId - The id of the Google auth user.
* @param {number} id - The id of the order.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The order with its lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The order with its lines.
* @throws {Error} If the order is not found.
*
* @example
* const order = await store.order.getById(42, 5);
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, id) => {
if (!Number.isFinite(id)) {

View File

@@ -9,11 +9,11 @@ export default function list(pool) {
* Lists the orders of the user's selected company.
*
* @param {number} googleAuthId - The id of the Google auth user.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number|null, date: string}>>} The orders.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string}>>} The orders.
*
* @example
* const orders = await store.order.list(42);
* // => [{ id, number, type, entityId, date }]
* // => [{ id, number, type, entityId, externalNumber, date }]
*/
return async (googleAuthId) => {
const { companyId } = await access(googleAuthId);

View File

@@ -23,8 +23,9 @@ export default function update(pool) {
* @param {string} [patch.number] - The new order number.
* @param {string} [patch.date] - The new order date.
* @param {number} [patch.entityId] - The new customer entity id.
* @param {string} [patch.externalNumber] - The new external (customer) reference number.
* @param {Array<object>} [patch.lines] - The new order lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The updated order.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The updated order.
* @throws {Error} If the order is not found.
*
* @example
@@ -39,9 +40,10 @@ export default function update(pool) {
const hasNumber = Object.prototype.hasOwnProperty.call(patch, 'number');
const hasDate = Object.prototype.hasOwnProperty.call(patch, 'date');
const hasEntityId = Object.prototype.hasOwnProperty.call(patch, 'entityId');
const hasExternalNumber = Object.prototype.hasOwnProperty.call(patch, 'externalNumber');
const hasLines = Object.prototype.hasOwnProperty.call(patch, 'lines');
if (!hasNumber && !hasDate && !hasEntityId && !hasLines) {
if (!hasNumber && !hasDate && !hasEntityId && !hasExternalNumber && !hasLines) {
throw new Error('Invalid order');
}
@@ -95,12 +97,20 @@ export default function update(pool) {
);
}
let externalNumber = summary.externalNumber;
if (hasExternalNumber) {
externalNumber = patch.externalNumber?.trim?.()
? patch.externalNumber.trim()
: null;
}
await request(pool, tx)
.input('id', id)
.input('companyId', companyId)
.input('type', ORDER_TYPE)
.input('number', number)
.input('entityId', entityId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(UPDATE_MANIFEST);

View File

@@ -17,13 +17,14 @@ export default function create(pool) {
* @param {string} body.number - The quote number.
* @param {string} body.date - The quote date.
* @param {number} [body.entityId] - The id of the customer entity.
* @param {string} [body.externalNumber] - An external (customer) reference number.
* @param {Array<object>} [body.lines] - The quote lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The created quote.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The created quote.
* @throws {Error} If the quote is invalid.
*
* @example
* const quote = await store.quote.create(42, { number: 'A-2026-001', date: '2026-09-01', entityId: 12, lines: [...] });
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, body = {}) => {
const number = body.number?.trim?.() ? body.number.trim() : null;
@@ -31,6 +32,9 @@ export default function create(pool) {
if (!number || !date) {
throw new Error('Invalid quote');
}
const externalNumber = body.externalNumber?.trim?.()
? body.externalNumber.trim()
: null;
const lines = normalizeLines(body.lines ?? []);
const { companyId, rootCategoryId } = await access(googleAuthId);
@@ -51,6 +55,7 @@ export default function create(pool) {
.input('number', number)
.input('type', QUOTE_TYPE)
.input('entityId', entityId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(CREATE_MANIFEST);

View File

@@ -10,12 +10,12 @@ export default function getById(pool) {
*
* @param {number} googleAuthId - The id of the Google auth user.
* @param {number} id - The id of the quote.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The quote with its lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The quote with its lines.
* @throws {Error} If the quote is not found.
*
* @example
* const quote = await store.quote.getById(42, 5);
* // => { id, number, type, entityId, date, lines: [...] }
* // => { id, number, type, entityId, externalNumber, date, lines: [...] }
*/
return async (googleAuthId, id) => {
if (!Number.isFinite(id)) {

View File

@@ -9,11 +9,11 @@ export default function list(pool) {
* Lists the quotes of the user's selected company.
*
* @param {number} googleAuthId - The id of the Google auth user.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number|null, date: string}>>} The quotes.
* @returns {Promise<Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string}>>} The quotes.
*
* @example
* const quotes = await store.quote.list(42);
* // => [{ id, number, type, entityId, date }]
* // => [{ id, number, type, entityId, externalNumber, date }]
*/
return async (googleAuthId) => {
const { companyId } = await access(googleAuthId);

View File

@@ -23,8 +23,9 @@ export default function update(pool) {
* @param {string} [patch.number] - The new quote number.
* @param {string} [patch.date] - The new quote date.
* @param {number} [patch.entityId] - The new customer entity id.
* @param {string} [patch.externalNumber] - The new external (customer) reference number.
* @param {Array<object>} [patch.lines] - The new quote lines.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, date: string, lines: Array<object>}>} The updated quote.
* @returns {Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<object>}>} The updated quote.
* @throws {Error} If the quote is not found.
*
* @example
@@ -39,9 +40,10 @@ export default function update(pool) {
const hasNumber = Object.prototype.hasOwnProperty.call(patch, 'number');
const hasDate = Object.prototype.hasOwnProperty.call(patch, 'date');
const hasEntityId = Object.prototype.hasOwnProperty.call(patch, 'entityId');
const hasExternalNumber = Object.prototype.hasOwnProperty.call(patch, 'externalNumber');
const hasLines = Object.prototype.hasOwnProperty.call(patch, 'lines');
if (!hasNumber && !hasDate && !hasEntityId && !hasLines) {
if (!hasNumber && !hasDate && !hasEntityId && !hasExternalNumber && !hasLines) {
throw new Error('Invalid quote');
}
@@ -95,12 +97,20 @@ export default function update(pool) {
);
}
let externalNumber = summary.externalNumber;
if (hasExternalNumber) {
externalNumber = patch.externalNumber?.trim?.()
? patch.externalNumber.trim()
: null;
}
await request(pool, tx)
.input('id', id)
.input('companyId', companyId)
.input('type', QUOTE_TYPE)
.input('number', number)
.input('entityId', entityId)
.input('externalNumber', externalNumber)
.input('date', date)
.query(UPDATE_MANIFEST);