2020-04-29 18:44:27 +03:00
|
|
|
const socialUrls = require('@tryghost/social-urls');
|
2016-05-17 17:06:09 +03:00
|
|
|
|
2016-01-17 13:07:52 +03:00
|
|
|
function getStructuredData(metaData) {
|
2020-04-29 18:44:27 +03:00
|
|
|
let structuredData;
|
|
|
|
|
let card = 'summary';
|
2016-01-17 13:07:52 +03:00
|
|
|
|
2019-05-06 06:51:44 +03:00
|
|
|
if (metaData.twitterImage || metaData.coverImage.url) {
|
2016-01-17 13:07:52 +03:00
|
|
|
card = 'summary_large_image';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
structuredData = {
|
2019-09-10 12:37:04 +03:00
|
|
|
'og:site_name': metaData.site.title,
|
2016-01-17 13:07:52 +03:00
|
|
|
'og:type': metaData.ogType,
|
2019-11-21 16:08:00 +03:00
|
|
|
'og:title': metaData.ogTitle,
|
2017-08-01 11:39:34 +03:00
|
|
|
// CASE: metaData.excerpt for post context is populated by either the custom excerpt,
|
|
|
|
|
// the meta description, or the automated excerpt of 50 words. It is empty for any
|
|
|
|
|
// other context and *always* uses the provided meta description fields.
|
2019-11-21 16:08:00 +03:00
|
|
|
'og:description': metaData.ogDescription,
|
2016-01-17 13:07:52 +03:00
|
|
|
'og:url': metaData.canonicalUrl,
|
2017-08-03 14:48:39 +03:00
|
|
|
'og:image': metaData.ogImage.url || metaData.coverImage.url,
|
2016-01-17 13:07:52 +03:00
|
|
|
'article:published_time': metaData.publishedDate,
|
|
|
|
|
'article:modified_time': metaData.modifiedDate,
|
|
|
|
|
'article:tag': metaData.keywords,
|
2019-09-10 12:37:04 +03:00
|
|
|
'article:publisher': metaData.site.facebook ? socialUrls.facebook(metaData.site.facebook) : undefined,
|
2019-06-06 18:01:03 +03:00
|
|
|
'article:author': metaData.authorFacebook ? socialUrls.facebook(metaData.authorFacebook) : undefined,
|
2016-01-17 13:07:52 +03:00
|
|
|
'twitter:card': card,
|
2019-11-21 16:08:00 +03:00
|
|
|
'twitter:title': metaData.twitterTitle,
|
|
|
|
|
'twitter:description': metaData.twitterDescription,
|
2016-01-17 13:07:52 +03:00
|
|
|
'twitter:url': metaData.canonicalUrl,
|
2017-08-03 14:48:39 +03:00
|
|
|
'twitter:image': metaData.twitterImage || metaData.coverImage.url,
|
2016-02-20 18:55:35 +03:00
|
|
|
'twitter:label1': metaData.authorName ? 'Written by' : undefined,
|
|
|
|
|
'twitter:data1': metaData.authorName,
|
|
|
|
|
'twitter:label2': metaData.keywords ? 'Filed under' : undefined,
|
2016-03-03 11:52:27 +03:00
|
|
|
'twitter:data2': metaData.keywords ? metaData.keywords.join(', ') : undefined,
|
2019-09-10 12:37:04 +03:00
|
|
|
'twitter:site': metaData.site.twitter || undefined,
|
2016-05-17 17:06:09 +03:00
|
|
|
'twitter:creator': metaData.creatorTwitter || undefined
|
2016-01-17 13:07:52 +03:00
|
|
|
};
|
|
|
|
|
|
2017-08-03 14:48:39 +03:00
|
|
|
if (metaData.ogImage.dimensions) {
|
|
|
|
|
structuredData['og:image:width'] = metaData.ogImage.dimensions.width;
|
|
|
|
|
structuredData['og:image:height'] = metaData.ogImage.dimensions.height;
|
|
|
|
|
} else if (metaData.coverImage.dimensions) {
|
✨ [FEATURE] AMP⚡ (#7229)
closes #6588, #7095
* `ImageObject` with image dimensions (#7152, #7151, #7153)
- Returns meta data as promise
- returns a new Promise from meta data
- uses `Promise.props()` to resolve `getClient()` and `getMetaData()`
- Adds 'image-size' util
The util returns an object like this
```
{
height: 50,
url: 'http://myblog.com/images/cat.jpg',
width: 50
};
```
if the dimensions can be fetched and rejects with error, if not.
In case we get a locally stored image or a not complete url (like `//www.gravatar.com/andsoon`), we add the protocol to the incomplete one and use `urlFor()` to get the absolute URL. If the request fails or `image-size` is not able to read the file, we reject with error.
- adds 'image-size' module to dependencies
- adds `getImageSizeFromUrl` function that returns image dimensions
- In preparation of AMP support and to improve our schema.org JSON-LD and structured data, I made the following changes:
- Changes the following properties to be `Objects`, which have a `url` property by default and a `dimensions` property, if `width` and `height` are available:
- `metaData.coverImage`
- `metaData.authorImage`
- `metaData.blog.logo`
- Checks cache by calling `getCachedImageSizeFromUrl`. If image dimensions were fetched already, returns them from cache instead of fetching them again.
- If we have image dimensions on hand, the output in our JSON-LD changes from normal urls to be full `ImageObjects`. Applies to all images and logos.
- Special case for `publisher.logo` as it has size restrictions: if the image doesn't fulfil the restrictions (<=600 width and <=60 height), we simply output the url instead, so like before.
- Adds new property for schema.org JSON-LD: `mainEntityOfPage` as an Object.
- Adds additional Open Graph data (if we have the image size): `og:image:width` and `og:image:height`
- Adds/updates tests
* AMP router and controller (#7171, #7157)
Implements AMP in `/apps/`:
- renders `amp.hbs` if route is `/:slug/amp/`
- updates `setResponseContext` to set context to `['amp', 'post']` for a amp post and `['amp', 'page']` for a page, but will not render amp template for a page
- updates `context_spec`
- registers 'amp' as new internal app
- adds the `amp.hbs` template to `core/server/apps/amp` which will be the default template for AMP posts.
- adds `isAmpURL` to `post-lookup`
* 🎨 Use `context` in meta as array (#7205)
Instead of reading the first value of the context array, we're checking if it includes certain context values.
This is a preparation change for AMP, where the context will be delivered as `['amp', 'post']`.
* ✨ AMP helpers (#7174, #7216, #7215, #7223)
- Adds AMP helpers `{{amp_content}}`, `{{amp_component}}` and `{{amp_ghost_head}}` to support AMP:
- `{{amp_content}}`:
- Adds `Amperize` as dependency
- AMP app uses new helper `{{amp_content}}` to render AMP HTML
- `Amperize` transforms regular HTML into AMP HTML
- Adds test for `{{amp_content}}` helper
- Adds 'Sanitize-HTML` as dependendy
- After the HTML get 'amperized' we still might have some HTML tags, which are prohibited in AMP HTML, so we use `sanitize-html` to remove those. With every update, `Amperize` gets and it is able to transform more HTML tags, they valid AMP HTML tags (e. g. `video` and `amp-video`) and will therefore not be removed.
- `{{amp_ghost_head}}`:
- registers `{{amp_ghost_head}}` helper, but uses `{{ghost_head}}` code
- uses `{{amp_ghost_head}}` in `amp.hbs` instead of `{{ghost_head}}`
- `{{ghost_head}}`:
- Render `amphtml` link in metadata for post, which links to the amp post (`getAmpUrl`)
- Updates all test in metadata to support `amp` context
- Changes context conditionals to work with full array instead of first array value
- Adds conditionals, so no additional javascript gets rendered in `{{ghost_head}}`
- Removes trailing `/amp/` in URLs, so only `amphtml` link on regular post renders it
- Adds a conditional, so no code injection will be included, for an `amp` context.
- `{{amp_components}}`:
- AMP app uses new helper `{{amp_components}}` to render necessary script tags for AMP extended components as `amp-iframe`, `amp-anime` and `amp-form`
- Adds test for `{{amp_components}}`
2016-08-22 19:49:27 +03:00
|
|
|
structuredData['og:image:width'] = metaData.coverImage.dimensions.width;
|
|
|
|
|
structuredData['og:image:height'] = metaData.coverImage.dimensions.height;
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-20 18:55:35 +03:00
|
|
|
// return structured data removing null or undefined keys
|
2016-01-17 13:07:52 +03:00
|
|
|
return Object.keys(structuredData).reduce(function (data, key) {
|
2020-04-29 18:44:27 +03:00
|
|
|
const content = structuredData[key];
|
2016-01-17 13:07:52 +03:00
|
|
|
if (content !== null && typeof content !== 'undefined') {
|
|
|
|
|
data[key] = content;
|
|
|
|
|
}
|
|
|
|
|
return data;
|
|
|
|
|
}, {});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = getStructuredData;
|
