@manyos/smileconnect-api 1.72.4 → 1.73.0

package/docs/releases.md

@@ -1,7 +1,10 @@
 # Release Notes
 
 ## API
-### 1.72.3 - 20.01.26
+### 1.73.0 - 28.04.26
+Add detectMime flag to attachments & attachments to dynamic openapi spec.
+
+### 1.72.4 - 18.03.26
 Improve connection handling on OAUTH2 Adapater & LDAP Adapter
 
 ### 1.72.2 - 14.11.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.72.4",
+  "version": "1.73.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {
@@ -27,8 +27,10 @@
     "express-request-id": "^1.4.1",
     "express-validator": "^6.10.1",
     "fast-xml-parser": "^3.20.3",
+    "file-type": "^16.5.4",
     "https-proxy-agent": "^5.0.1",
     "jsonwebtoken": "^9.0.2",
+    "mime-types": "^2.1.35",
     "moment": "^2.29.1",
     "mongoose": "^5.12.5",
     "node-cache": "^4.2.1",

package/test/incidentTest.js

@@ -362,6 +362,19 @@ describe('Integration Tests - Incidents', function () {
                 })
         })
 
+        it('it should detect image/png when detectMime=true', function (done) {
+            this.timeout(5000);
+            chai.request(server)
+                .get(attachmentUrl + '?detectMime=true')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .end(function (err, res) {
+                    res.should.have.status(200);
+                    res.should.have.header('content-type', 'image/png');
+                    res.should.have.header('content-disposition', 'attachment; filename=logo.png');
+                    done();
+                })
+        })
+
 
         it ('it should get all incident worklogs', function (done) {
             this.timeout(5000);

package/test/testUtils.js

@@ -4,7 +4,7 @@ const expect = chai.expect;
 this.authenticateUser = (user, app) =>
     new Promise((resolve, reject) => {
         chai.request('https://sso.manyos.it')
-            .post('/auth/realms/itsmproxy/protocol/openid-connect/token')
+            .post('/realms/itsmproxy/protocol/openid-connect/token')
             .auth(user.id, user.secret)
             .type('form')
             .send({

package/util/arquery.js

@@ -1,6 +1,8 @@
 require('dotenv').config();
 const request = require('request-promise-native');
 const path = require('path');
+const mime = require('mime-types');
+const FileType = require('file-type');
 const {getEventLog} = require("./eventLog");
 let log = require('@manyos/logger').setupLog('SMILEconnect', path.basename(__filename));
 
@@ -315,13 +317,24 @@ function getAttachment(form, entryId, attachmentfield) {
 
         log.debug('start attachment request on:', uri);
         request(options).auth(process.env.AR_USER, process.env.AR_PASSWORD, true)
-            .then(function (response) {
+            .then(async function (response) {
                 log.debug('RAPI return', response.headers);
                 const fileName = response.headers['content-disposition'].split(';')[1].split('=')[1];
                 log.debug('filename', fileName);
+                const fromExt = mime.lookup(fileName);
+                let fromMagic = null;
+                if (!fromExt) {
+                    try {
+                        fromMagic = (await FileType.fromBuffer(response.body))?.mime;
+                    } catch (err) {
+                        log.debug('file-type detection failed, falling back to octet-stream', err.message);
+                    }
+                }
+                const contentType = fromExt || fromMagic || 'application/octet-stream';
                 const file = {
                     data : response.body,
-                    fileName : fileName
+                    fileName : fileName,
+                    contentType : contentType
                 }
                 resolve(file);
             })

package/util/config.js

@@ -435,6 +435,7 @@ async function getDesignPackage(clientId) {
                 schemas[config.requestTypeWorkLog] = await getObjectSchema(clientConfig[config.requestTypeWorkLog].fields, mapping, config.forms.workLog)
                 schemas[config.requestTypeWorkLog + '_create_update'] = await getObjectSchema(clientConfig[config.requestTypeWorkLog].fields, mapping, config.forms.workLog, true)
                 paths = {...paths, ... await getPathDef(config.assocTicketType, config.baseURI + '/{ticketId}/worklogs', config.requestTypeWorkLog, true, true)}
+                paths = {...paths, ... await getAttachmentPathDef(config.assocTicketType, config.baseURI + '/{ticketId}/worklogs')}
             }
             if (config.requestTemplate && clientConfig[config.requestTemplate].fields  && clientConfig[config.requestTemplate].fields.length > 0) {
                 const mapping = getDeprecatedMappingAsCustom(config.requestTemplate)
@@ -552,7 +553,25 @@ async function getDesignPackage(clientId) {
         paths = {...paths, ... await getPathDef('cmdbobject', '/v1/cmdbobjects', cmdbSchemaList)}
     }
 
-    return {openapi: "3.0.1", info, servers, paths, components: {schemas}}
+    const attachmentResponse = {
+        description: "Attachment binary content. Content-Type is application/octet-stream by default; with ?detectMime=true it reflects the detected MIME type (extension lookup with magic-byte fallback).",
+        headers: {
+            "Content-Disposition": {
+                description: "attachment; filename=<filename>",
+                schema: { type: "string" }
+            }
+        },
+        content: {
+            "application/octet-stream": { schema: { type: "string", format: "binary" } },
+            "application/pdf":          { schema: { type: "string", format: "binary" } },
+            "image/png":                { schema: { type: "string", format: "binary" } },
+            "image/jpeg":               { schema: { type: "string", format: "binary" } },
+            "image/gif":                { schema: { type: "string", format: "binary" } },
+            "text/plain":               { schema: { type: "string", format: "binary" } }
+        }
+    }
+
+    return {openapi: "3.0.1", info, servers, paths, components: {schemas, responses: {attachmentResponse}}}
 }
 
 async function getPathDef(objectName, baseUri, schema, isSubTicket, suppressUpdate, suppressCreate) {
@@ -632,6 +651,76 @@ async function getPathDef(objectName, baseUri, schema, isSubTicket, suppressUpda
     return pathDef
 }
 
+async function getAttachmentPathDef(objectName, workLogBaseUri) {
+    const ticketIdParam = {
+        name: "ticketId",
+        description: "id of the parent ticket",
+        schema: { "type": "string" },
+        in: "path",
+        required: true
+    }
+    const worklogIdParam = {
+        name: "worklogId",
+        description: "id of the worklog the attachment belongs to",
+        schema: { "type": "string" },
+        in: "path",
+        required: true
+    }
+    const detectMimeParam = {
+        name: "detectMime",
+        description: "If set to 'true', the response Content-Type reflects the detected MIME type of the attachment (filename extension lookup with magic-byte fallback). Without the parameter the response keeps the legacy default 'application/octet-stream' for backwards compatibility.",
+        schema: {
+            type: "string",
+            enum: ["true", "false"]
+        },
+        in: "query",
+        required: false,
+        examples: {
+            detect: { value: "true" }
+        }
+    }
+
+    const pathDef = {}
+    for (const slot of [1, 2, 3]) {
+        const uri = `${workLogBaseUri}/{worklogId}/attachments/${slot}`
+        pathDef[uri] = {
+            parameters: [ticketIdParam, worklogIdParam],
+            get: {
+                tags: [objectName, 'Attachments'],
+                summary: `Download attachment ${slot} of a ${objectName} worklog`,
+                description: "Returns the binary attachment. Default Content-Type is application/octet-stream; pass ?detectMime=true to receive the detected MIME type.",
+                parameters: [detectMimeParam],
+                responses: {
+                    "200": { "$ref": "#/components/responses/attachmentResponse" }
+                }
+            },
+            post: {
+                tags: [objectName, 'Attachments'],
+                summary: `Upload attachment ${slot} for a ${objectName} worklog`,
+                description: 'Send the file in the form field "file".',
+                requestBody: {
+                    required: true,
+                    content: {
+                        "multipart/form-data": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    file: { type: "string", format: "binary" }
+                                },
+                                required: ["file"]
+                            }
+                        }
+                    }
+                },
+                responses: {
+                    "200": { description: "Attachment added" }
+                }
+            }
+        }
+    }
+    return pathDef
+}
+
 function getOpenApiParameters(operation) {
     const parameters = [
         {

package/util/responsehandler.js

@@ -103,6 +103,11 @@ function eventQueueHandler(req, res, next) {
             req.log
             ).then( success => {
                 if (req.downloadResult) {
+                    const detect = req.query && req.query.detectMime === 'true';
+                    const contentType = detect
+                        ? (req.downloadResult.contentType || 'application/octet-stream')
+                        : 'application/octet-stream';
+                    res.set('Content-Type', contentType);
                     res.set('Content-disposition', 'attachment; filename=' + req.downloadResult.fileName);
                     res.status(200).send(req.downloadResult.data);
                 } else {