@quintype/seo 1.43.0 → 1.44.0

package/CHANGELOG.md

@@ -2,7 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [1.43.0](https://github.com/quintype/quintype-node-seo/compare/v1.43.0-config-amp-story-path.1...v1.43.0) (2023-12-01)
+## [1.44.0](https://github.com/quintype/quintype-node-seo/compare/v1.43.0...v1.44.0) (2024-01-04)
+
+## [1.43.0-disable-amp-story.1](https://github.com/quintype/quintype-node-seo/compare/v1.43.0-disable-amp-story.0...v1.43.0-disable-amp-story.1) (2023-11-22)
+
+## [1.43.0-disable-amp-story.0](https://github.com/quintype/quintype-node-seo/compare/v1.42.2...v1.43.0-disable-amp-story.0) (2023-11-22)
+
+
+### Features
+
+* disable amp for a particular story ([6b5a76d](https://github.com/quintype/quintype-node-seo/commit/6b5a76da754bf2cbabd9a8d0787095366bf18609))
 
 ### [1.42.2](https://github.com/quintype/quintype-node-seo/compare/v1.42.1...v1.42.2) (2023-07-06)
 

package/dist/index.cjs.js

@@ -62,6 +62,12 @@ function showAmpTag({ ampStoryPages = true }, pageType, story) {
     return false;
   }
 
+  const isAmpDisabled = get__default["default"](story, ["metadata", "story-attributes", "disable-amp-for-single-story", "0"], "false");
+
+  if (isAmpDisabled === "true") {
+    return false;
+  }
+
   if (ampStoryPages === "public" && !isStoryPublic(story)) {
     return false;
   }
@@ -81,6 +87,9 @@ const getDomain = (url, domainSlug) => {
 /**
  * StoryAmpTags adds the amphref to stories which support amp.
  *
+ * To disable adding amphref for a specific story, you need to create a story attribute in bold with the slug {disable-amp-for-single-story} and values {true} and {false}. Set its value to "true" in the story which you want to disable amp. Please make sure to name the attributes and values in the exact same way as mentioned
+ * attribute slug: "disable-amp-for-single-story" values: "true" , "false"
+ *
  * @extends Generator
  * @param {*} seoConfig
  * @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
@@ -96,8 +105,7 @@ function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
   // 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 { ampPageBasePath = "/amp/story" } = seoConfig;
-  const ampUrl = story["story-template"] === "visual-story" ? `${ampUrlAppend}/${storySlug}` : `${ampUrlAppend}${ampPageBasePath}/${storySlug}`;
+  const ampUrl = story["story-template"] === "visual-story" ? `${ampUrlAppend}/${storySlug}` : `${ampUrlAppend}/amp/story/${storySlug}`;
   const ignoreStoryTemplate = templatesToIgnore.includes(story["story-template"]);
   if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
     return [{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/seo",
-  "version": "1.43.0",
+  "version": "1.44.0",
   "description": "SEO Modules for Quintype",
   "main": "dist/index.cjs.js",
   "repository": "https://github.com/quintype/quintype-node-seo",

package/src/amp-tags.js

@@ -6,6 +6,12 @@ function showAmpTag({ ampStoryPages = true }, pageType, story) {
     return false;
   }
 
+  const isAmpDisabled = get(story, ["metadata", "story-attributes", "disable-amp-for-single-story", "0"], "false");
+
+  if (isAmpDisabled === "true") {
+    return false;
+  }
+
   if (ampStoryPages === "public" && !isStoryPublic(story)) {
     return false;
   }
@@ -25,6 +31,9 @@ const getDomain = (url, domainSlug) => {
 /**
  * StoryAmpTags adds the amphref to stories which support amp.
  *
+ * To disable adding amphref for a specific story, you need to create a story attribute in bold with the slug {disable-amp-for-single-story} and values {true} and {false}. Set its value to "true" in the story which you want to disable amp. Please make sure to name the attributes and values in the exact same way as mentioned
+ * attribute slug: "disable-amp-for-single-story" values: "true" , "false"
+ *
  * @extends Generator
  * @param {*} seoConfig
  * @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
@@ -42,11 +51,10 @@ export function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
     ? getDomain(currentHostUrl, domainSlug) || config["sketches-host"]
     : "";
   const storySlug = seoConfig.decodeAmpUrl ? decodeURIComponent(story.slug) : encodeURIComponent(story.slug);
-  const { ampPageBasePath = "/amp/story" } = seoConfig;
   const ampUrl =
     story["story-template"] === "visual-story"
       ? `${ampUrlAppend}/${storySlug}`
-      : `${ampUrlAppend}${ampPageBasePath}/${storySlug}`;
+      : `${ampUrlAppend}/amp/story/${storySlug}`;
   const ignoreStoryTemplate = templatesToIgnore.includes(story["story-template"]);
   if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
     return [

package/test/amp_tags_test.js

@@ -25,6 +25,26 @@ describe("AmpTags", function () {
     assertContains('<link rel="amphtml" href="/amp/story/section%2Fslug"/>', string);
   });
 
+  it("does not add amphtml link tag to story pages which has disableamp attribute set to true", function () {
+    const story = {
+      slug: "section/slug",
+      "is-amp-supported": true,
+      metadata: { "story-attributes": { "disable-amp-for-single-story": ["true"] } },
+    };
+    const string = getSeoMetadata(seoConfig, config, "story-page", { data: { story: story } }, {});
+    assert.equal("", string);
+  });
+
+  it("does not add amphtml link tag to story pages which has disableamp attribute set to false", function () {
+    const story = {
+      slug: "section/slug",
+      "is-amp-supported": true,
+      metadata: { "story-attributes": { "disable-amp-for-single-story": ["false"] } },
+    };
+    const string = getSeoMetadata(seoConfig, config, "story-page", { data: { story: story } }, {});
+    assert.equal('<link rel="amphtml" href="/amp/story/section%2Fslug"/>', string);
+  });
+
   it("does not add amphtml link tag to amp story pages", function () {
     const story = { slug: "section/slug", "is-amp-supported": true };
     const string = getSeoMetadata(seoConfig, config, "story-page-amp", { data: { story: story } }, {});