u
This commit is contained in:
@@ -1,4 +1,5 @@
|
||||
import * as db from '../../db/shipment.js';
|
||||
import { createAndAttachManifestPdf } from '../../services/manifestPdf.js';
|
||||
import { emit } from '../sse.js';
|
||||
|
||||
// #region Helpers
|
||||
@@ -383,4 +384,212 @@ export function register(app, basePath = '') {
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /shipment/{id}/pdf:
|
||||
* post:
|
||||
* tags: [Shipment]
|
||||
* summary: Generate and attach shipment PDF (delivery note)
|
||||
* description: |
|
||||
* Generates an A4 delivery note PDF document for the shipment with line items and package tracking.
|
||||
* Shipping slips contain no price information.
|
||||
* Attaches the PDF as a `manifestattachment` to the shipment so it can be printed or attached to packages.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* x-signals: [shipment]
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Shipment ID
|
||||
* responses:
|
||||
* 201:
|
||||
* description: PDF generated and attached to shipment
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required: [attachment, fileUrl]
|
||||
* properties:
|
||||
* attachment:
|
||||
* $ref: '#/components/schemas/DeliveryFile'
|
||||
* fileUrl:
|
||||
* type: string
|
||||
* example: /shipment/1/file/5
|
||||
* 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: Shipment not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region POST /shipment/:id/pdf
|
||||
|
||||
app.post(`${basePath}/shipment/:id/pdf`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsedId = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsedId.error) {
|
||||
return res.status(400).json({ error: parsedId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const { attachment } = await createAndAttachManifestPdf(
|
||||
req.user.id,
|
||||
selected.companyId,
|
||||
parsedId.id,
|
||||
'shipment'
|
||||
);
|
||||
|
||||
res.status(201).json({
|
||||
attachment,
|
||||
fileUrl: `/shipment/${parsedId.id}/file/${attachment.fileId}`,
|
||||
});
|
||||
} catch (error) {
|
||||
const status = shipmentErrorStatus(error);
|
||||
if (status === 500) console.error('Create shipment PDF failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /shipment/{id}/file/{fileId}:
|
||||
* get:
|
||||
* tags: [Shipment]
|
||||
* summary: Get shipment attachment file content
|
||||
* description: |
|
||||
* Returns the full binary content of an attached file (e.g. shipment delivery note PDF)
|
||||
* for the specified shipment. Supports HTTP caching via ETag (SHA-256 hash) and 304 Not Modified.
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Shipment ID
|
||||
* - in: path
|
||||
* name: fileId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: File ID or attachment ID
|
||||
* - in: query
|
||||
* name: download
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* description: When true, sets Content-Disposition to attachment instead of inline
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Binary file content
|
||||
* content:
|
||||
* application/pdf:
|
||||
* schema:
|
||||
* type: string
|
||||
* format: binary
|
||||
* application/octet-stream:
|
||||
* schema:
|
||||
* type: string
|
||||
* format: binary
|
||||
* 304:
|
||||
* description: Not modified
|
||||
* 400:
|
||||
* description: Invalid ID or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Shipment or file not found
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
// #region GET /shipment/:id/file/:fileId
|
||||
|
||||
app.get(`${basePath}/shipment/:id/file/:fileId`, async (req, res) => {
|
||||
const selected = requireSelectedCompany(req);
|
||||
if (selected.error) {
|
||||
return res.status(400).json({ error: selected.error });
|
||||
}
|
||||
|
||||
const parsedId = parsePositiveInt(req.params.id, 'id');
|
||||
if (parsedId.error) {
|
||||
return res.status(400).json({ error: parsedId.error });
|
||||
}
|
||||
|
||||
const parsedFileId = parsePositiveInt(req.params.fileId, 'fileId');
|
||||
if (parsedFileId.error) {
|
||||
return res.status(400).json({ error: parsedFileId.error });
|
||||
}
|
||||
|
||||
try {
|
||||
const attachment = await db.getFile(req.user.id, parsedId.id, parsedFileId.id);
|
||||
|
||||
if (attachment.hash) {
|
||||
const etag = `"${attachment.hash}"`;
|
||||
res.setHeader('ETag', etag);
|
||||
const ifNoneMatch = req.headers['if-none-match'];
|
||||
if (ifNoneMatch === etag || ifNoneMatch === attachment.hash) {
|
||||
return res.status(304).end();
|
||||
}
|
||||
}
|
||||
|
||||
const isDownload = req.query.download === '1' || req.query.download === 'true';
|
||||
const dispositionType = isDownload ? 'attachment' : 'inline';
|
||||
const filename = attachment.name || `file-${attachment.fileId}`;
|
||||
const asciiName = filename.replace(/["\r\n\\]/g, '_');
|
||||
const encodedName = encodeURIComponent(filename).replace(/['()]/g, escape);
|
||||
|
||||
res.setHeader('Content-Type', attachment.mimetype || 'application/octet-stream');
|
||||
res.setHeader('Content-Disposition', `${dispositionType}; filename="${asciiName}"; filename*=UTF-8''${encodedName}`);
|
||||
res.setHeader('Cache-Control', 'private, max-age=86400');
|
||||
|
||||
if (attachment.content && Buffer.isBuffer(attachment.content)) {
|
||||
res.setHeader('Content-Length', String(attachment.content.length));
|
||||
return res.status(200).send(attachment.content);
|
||||
} else {
|
||||
const buffer = Buffer.from(attachment.content || '');
|
||||
res.setHeader('Content-Length', String(buffer.length));
|
||||
return res.status(200).send(buffer);
|
||||
}
|
||||
} catch (error) {
|
||||
const status = shipmentErrorStatus(error);
|
||||
if (status === 500) console.error('Get shipment file failed:', error);
|
||||
res.status(status).json({ error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// #endregion
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user