0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-10 23:36:14 -05:00
ghost/core/frontend/services/rendering/format-response.js
Naz 1cc3f66d5f Reworked preview controller output
refs https://github.com/TryGhost/Toolbox/issues/332

- With 'page' property being gone from page/post resources we need consistency across internal "preview API" too
- the handling is still hacky as we are exposing the "type" property to the preview pages, which is not exposed through Content API. this a long outstanding issue will have to be handled separately
2022-05-17 17:21:38 +08:00

67 lines
1.7 KiB
JavaScript

const _ = require('lodash');
const {prepareContextResource} = require('../proxy');
/**
* @description Formats API response into handlebars/theme format.
*
* @return {Object} containing page variables
*/
function formatPageResponse(result) {
const response = {};
if (result.posts) {
response.posts = result.posts;
prepareContextResource(response.posts);
}
if (result.meta && result.meta.pagination) {
response.pagination = result.meta.pagination;
}
_.each(result.data, function (data, name) {
prepareContextResource(data);
if (data.meta) {
// Move pagination to be a top level key
response[name] = data;
response[name].pagination = data.meta.pagination;
delete response[name].meta;
} else {
// This is a single object, don't wrap it in an array
response[name] = data[0];
}
});
return response;
}
/**
* @description Format a single resource for handlebars.
*
* @TODO
* In the future, we should return {page: entry} or {post:entry).
* But for now, we would break the themes if we just change it.
*
* @see https://github.com/TryGhost/Ghost/issues/10042.
*
* @return {Object} containing page variables
*/
function formatResponse(post, context) {
prepareContextResource(post);
let entry = {
post: post
};
// NOTE: preview context is a special case where the internal preview api returns the post model's type field
if (context?.includes('page') || (context?.includes('preview') && post.type === 'page')) {
entry.page = post;
}
return entry;
}
module.exports = {
entries: formatPageResponse,
entry: formatResponse
};