@quintype/seo 1.41.3 → 1.41.4-gsc-errors-fix.0

package/dist/index.cjs.js

@@ -78,16 +78,18 @@ const getDomain = (url, domainSlug) => {
  * @param {(boolean|"public")} seoConfig.ampStoryPages Should amp story pages be shown for all stories (true), not shown (false), or only be shown for public stories ("public"). Default: true
  * @param {(boolean)} seoConfig.appendHostToAmpUrl If set to true, the url to be appended to the slug is computed based on the currentHostUrl and the domain slug, else the url is taken as the sketches host. Default: false
  * @param {(boolean)} seoConfig.decodeAmpUrl If set to true, the storySlug that goes as the amp href url is decoded, else the storyslug is encoded. Default: false
+ * @param {(boolean)} seoConfig.ignoreAmpHtmlStoryTemplates pass all the story templates you want to ignore from add rel="amphtml" tag. Default: ["visual story"]
  * @param {...*} params See {@link Generator} for other Parameters
  */
 function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
+  const templatesToIgnore = seoConfig.ignoreAmpHtmlStoryTemplates || ["visual-story"];
   const story = get__default["default"](data, ["data", "story"], {});
   const { currentHostUrl = "", domainSlug } = data;
   // TODO: Remove this condition and always make absolute URL if that's better for AMP discoverability.
   const ampUrlAppend = seoConfig.appendHostToAmpUrl ? getDomain(currentHostUrl, domainSlug) || config["sketches-host"] : "";
   const storySlug = seoConfig.decodeAmpUrl ? decodeURIComponent(story.slug) : encodeURIComponent(story.slug);
   const ampUrl = story["story-template"] === "visual-story" ? `${ampUrlAppend}/${storySlug}` : `${ampUrlAppend}/amp/story/${storySlug}`;
-  const ignoreStoryTemplate = seoConfig.ignoreAmpHtmlStoryTemplates && seoConfig.ignoreAmpHtmlStoryTemplates.includes(story["story-template"]);
+  const ignoreStoryTemplate = templatesToIgnore.includes(story["story-template"]);
   if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
     return [{
       tag: "link",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.41.3",
+  "version": "1.41.4-gsc-errors-fix.0",
   "description": "SEO Modules for Quintype",
   "main": "dist/index.cjs.js",
   "repository": "https://github.com/quintype/quintype-node-seo",

package/src/amp-tags.js

@@ -30,9 +30,11 @@ const getDomain = (url, domainSlug) => {
  * @param {(boolean|"public")} seoConfig.ampStoryPages Should amp story pages be shown for all stories (true), not shown (false), or only be shown for public stories ("public"). Default: true
  * @param {(boolean)} seoConfig.appendHostToAmpUrl If set to true, the url to be appended to the slug is computed based on the currentHostUrl and the domain slug, else the url is taken as the sketches host. Default: false
  * @param {(boolean)} seoConfig.decodeAmpUrl If set to true, the storySlug that goes as the amp href url is decoded, else the storyslug is encoded. Default: false
+ * @param {(boolean)} seoConfig.ignoreAmpHtmlStoryTemplates pass all the story templates you want to ignore from add rel="amphtml" tag. Default: ["visual story"]
  * @param {...*} params See {@link Generator} for other Parameters
  */
 export function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
+  const templatesToIgnore = seoConfig.ignoreAmpHtmlStoryTemplates || ["visual-story"];
   const story = get(data, ["data", "story"], {});
   const { currentHostUrl = "", domainSlug } = data;
   // TODO: Remove this condition and always make absolute URL if that's better for AMP discoverability.
@@ -44,8 +46,7 @@ export function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
     story["story-template"] === "visual-story"
       ? `${ampUrlAppend}/${storySlug}`
       : `${ampUrlAppend}/amp/story/${storySlug}`;
-  const ignoreStoryTemplate =
-    seoConfig.ignoreAmpHtmlStoryTemplates && seoConfig.ignoreAmpHtmlStoryTemplates.includes(story["story-template"]);
+  const ignoreStoryTemplate = templatesToIgnore.includes(story["story-template"]);
   if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
     return [
       {

package/test/amp_tags_test.js

@@ -1,9 +1,9 @@
 const { StoryAmpTags } = require("..");
 const { getSeoMetadata, assertContains } = require("./utils");
 
-const assert = require('assert');
+const assert = require("assert");
 
-describe('AmpTags', function () {
+describe("AmpTags", function () {
   const seoConfig = {
     generators: [StoryAmpTags],
     ampStoryPages: true,
@@ -19,12 +19,6 @@ describe('AmpTags', function () {
     assertContains('<link rel="amphtml" href="/amp/story/section%2Fslug"/>', string);
   });
 
-  it("it does not append `/amp/story` to the amp tag when it's a visual story", function () {
-    const story = { slug: "section/slug", "is-amp-supported": true };
-    const string = getSeoMetadata(seoConfig, config, "story-page", { data: { story: { ...story, "story-template": "visual-story" } } }, {});
-    assertContains('<link rel="amphtml" href="/section%2Fslug"/>', string);
-  });
-
   it("does not rely on is-amp-supported in story API", function () {
     const story = { slug: "section/slug", "is-amp-supported": false };
     const string = getSeoMetadata(seoConfig, config, "story-page", { data: { story: story } }, {});