fix(findSlug REST): incorrect response format (#13)

Author: ComfortablyCoding

package.json

@@ -36,6 +36,7 @@
 	},
 	"peerDependencies": {
 		"@strapi/strapi": "^4.0.7",
+		"@strapi/utils": "^4.0.7",
 		"lodash": "^4.17.21",
 		"yup": "^0.32.9"
 	},

server/controllers/slug-controller.js

@@ -1,7 +1,8 @@
 'use strict';
 
-const { getPluginService } = require('../utils/getPluginService');
 const _ = require('lodash');
+const { getPluginService } = require('../utils/getPluginService');
+const { transformResponse } = require('../utils/transformEntry');
 
 module.exports = ({ strapi }) => ({
 	async findSlug(ctx) {
@@ -42,9 +43,10 @@ module.exports = ({ strapi }) => ({
 			const data = await getPluginService(strapi, 'slugService').findOne(uid, query);
 
 			if (data) {
-				return ctx.send({ data });
+				ctx.body = transformResponse(data);
+			} else {
+				ctx.notFound();
 			}
-			ctx.notFound();
 		} catch (error) {
 			ctx.badRequest(error.message);
 		}

server/services/slug-service.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const _ = require('lodash');
 const { getPluginService } = require('../utils/getPluginService');
 const { stringToSlug } = require('../utils/stringToSlug');
 
@@ -29,6 +30,17 @@ module.exports = ({ strapi }) => ({
 	async findOne(uid, query) {
 		const slugs = await strapi.entityService.findMany(uid, query);
 
-		return slugs.length ? slugs[0] : null;
+		// single
+		if (slugs && _.isPlainObject(slugs)) {
+			return slugs;
+		}
+
+		// collection
+		if (slugs && _.isArray(slugs) && slugs.length) {
+			return slugs[0];
+		}
+
+		// no result
+		return null;
 	},
 });

server/utils/transformEntry.js

@@ -0,0 +1,85 @@
+'use strict';
+
+// copied from: https://raw.githubusercontent.com/strapi/strapi/master/packages/core/strapi/lib/core-api/controller/transform.js
+
+const { isNil, isPlainObject } = require('lodash/fp');
+
+const transformResponse = (resource, meta = {}, { contentType } = {}) => {
+	if (isNil(resource)) {
+		return resource;
+	}
+
+	return {
+		data: transformEntry(resource, contentType),
+		meta,
+	};
+};
+
+const transformComponent = (data, component) => {
+	if (Array.isArray(data)) {
+		return data.map((datum) => transformComponent(datum, component));
+	}
+
+	const res = transformEntry(data, component);
+
+	if (isNil(res)) {
+		return res;
+	}
+
+	const { id, attributes } = res;
+	return { id, ...attributes };
+};
+
+const transformEntry = (entry, type) => {
+	if (isNil(entry)) {
+		return entry;
+	}
+
+	if (Array.isArray(entry)) {
+		return entry.map((singleEntry) => transformEntry(singleEntry, type));
+	}
+
+	if (!isPlainObject(entry)) {
+		throw new Error('Entry must be an object');
+	}
+
+	const { id, ...properties } = entry;
+
+	const attributeValues = {};
+
+	for (const key in properties) {
+		const property = properties[key];
+		const attribute = type && type.attributes[key];
+
+		if (attribute && attribute.type === 'relation') {
+			const data = transformEntry(property, strapi.contentType(attribute.target));
+
+			attributeValues[key] = { data };
+		} else if (attribute && attribute.type === 'component') {
+			attributeValues[key] = transformComponent(property, strapi.components[attribute.component]);
+		} else if (attribute && attribute.type === 'dynamiczone') {
+			if (isNil(property)) {
+				attributeValues[key] = property;
+			}
+
+			attributeValues[key] = property.map((subProperty) => {
+				return transformComponent(subProperty, strapi.components[subProperty.__component]);
+			});
+		} else if (attribute && attribute.type === 'media') {
+			const data = transformEntry(property, strapi.contentType('plugin::upload.file'));
+
+			attributeValues[key] = { data };
+		} else {
+			attributeValues[key] = property;
+		}
+	}
+
+	return {
+		id,
+		attributes: attributeValues,
+	};
+};
+
+module.exports = {
+	transformResponse,
+};