@quintype/seo 1.41.0-canonical-toggle.0 → 1.41.1-gsc-errors.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.41.0](https://github.com/quintype/quintype-node-seo/compare/v1.40.15...v1.41.0) (2022-11-29)
+
+
+### Features
+
+* **canonical:** Add canonical url toggle ([#539](https://github.com/quintype/quintype-node-seo/issues/539)) ([3c18124](https://github.com/quintype/quintype-node-seo/commit/3c181249b7adb06061a8a4c16aa71b640b21679c))
+
+
+### Bug Fixes
+
+* **canonical:** Toggle canonical tags ([1f8a4fe](https://github.com/quintype/quintype-node-seo/commit/1f8a4fe0955688080095275290dabe79dc6344d6))
+
 ### [1.40.15](https://github.com/quintype/quintype-node-seo/compare/v1.40.14...v1.40.15) (2022-11-17)
 
 ### [1.40.14](https://github.com/quintype/quintype-node-seo/compare/v1.40.11...v1.40.14) (2022-11-16)

package/dist/index.cjs.js

@@ -50,11 +50,11 @@ function isStoryPublic(story) {
 }
 
 function showAmpTag({ ampStoryPages = true }, pageType, story) {
-  if (!ampStoryPages || pageType !== 'story-page') {
+  if (!ampStoryPages || pageType !== "story-page") {
     return false;
   }
 
-  if (ampStoryPages === 'public' && !isStoryPublic(story)) {
+  if (ampStoryPages === "public" && !isStoryPublic(story)) {
     return false;
   }
 
@@ -62,7 +62,7 @@ function showAmpTag({ ampStoryPages = true }, pageType, story) {
 }
 
 const getDomain = (url, domainSlug) => {
-  const domain = domainSlug ? new URL(url).origin : '';
+  const domain = domainSlug ? new URL(url).origin : "";
   try {
     return domain;
   } catch (err) {
@@ -81,18 +81,17 @@ const getDomain = (url, domainSlug) => {
  * @param {...*} params See {@link Generator} for other Parameters
  */
 function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
-
   const story = get__default["default"](data, ["data", "story"], {});
-  const { currentHostUrl = '', domainSlug } = data;
+  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 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}`;
-
-  if (showAmpTag(seoConfig, pageType, story)) {
+  const ignoreStoryTemplate = seoConfig.ignoreAmpHtmlStoryTemplates && seoConfig.ignoreAmpHtmlStoryTemplates.includes(story["story-template"]);
+  if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
     return [{
-      tag: 'link',
-      rel: 'amphtml',
+      tag: "link",
+      rel: "amphtml",
       href: ampUrl
     }];
   } else {

package/index.js

@@ -1,23 +1,35 @@
 import { flatMap, get, omit, uniqBy } from "lodash";
 import React from "react";
 import ReactDomServer from "react-dom/server";
-import { StoryAmpTags } from './src/amp-tags.js';
-import { AuthorTags } from './src/author-tags.js';
-import { generateStaticData, generateStructuredData } from './src/generate-common-seo';
-import { ImageTags } from './src/image-tags.js';
-import { StaticTags } from './src/static-tags.js';
-import { StructuredDataTags } from './src/structured-data/structured-data-tags.js';
-import { getTitle, TextTags } from './src/text-tags.js';
+import { StoryAmpTags } from "./src/amp-tags.js";
+import { AuthorTags } from "./src/author-tags.js";
+import { generateStaticData, generateStructuredData } from "./src/generate-common-seo";
+import { ImageTags } from "./src/image-tags.js";
+import { StaticTags } from "./src/static-tags.js";
+import { StructuredDataTags } from "./src/structured-data/structured-data-tags.js";
+import { getTitle, TextTags } from "./src/text-tags.js";
 
-
-export { TextTags, StaticTags, AuthorTags, ImageTags, StructuredDataTags, StoryAmpTags, generateStaticData, generateStructuredData };
+export {
+  TextTags,
+  StaticTags,
+  AuthorTags,
+  ImageTags,
+  StructuredDataTags,
+  StoryAmpTags,
+  generateStaticData,
+  generateStructuredData,
+};
 
 function tagToKey(tag) {
   switch (tag.tag || "meta") {
-    case "meta": return `meta-${tag.name || tag.itemprop || "name"}-${tag.property || "property"}`;
-    case "link": return `link-${tag.rel}`;
-    case "title": return `title`;
-    default: return Math.random().toString();
+    case "meta":
+      return `meta-${tag.name || tag.itemprop || "name"}-${tag.property || "property"}`;
+    case "link":
+      return `link-${tag.rel}`;
+    case "title":
+      return `title`;
+    default:
+      return Math.random().toString();
   }
 }
 
@@ -28,7 +40,9 @@ export class MetaTagList {
 
   toString() {
     const uniqueTags = uniqBy(this.tags.reverse(), tagToKey).reverse();
-    return ReactDomServer.renderToStaticMarkup(uniqueTags.map(tag => React.createElement(tag.tag || "meta", omit(tag, "tag"))));
+    return ReactDomServer.renderToStaticMarkup(
+      uniqueTags.map((tag) => React.createElement(tag.tag || "meta", omit(tag, "tag")))
+    );
   }
 
   addTag() {
@@ -93,12 +107,16 @@ export class SEO {
    */
   constructor(seoConfig = {}) {
     this.seoConfig = seoConfig;
-    this.generators = (seoConfig.generators || [TextTags, ImageTags, AuthorTags, StaticTags, StructuredDataTags, StoryAmpTags]).concat(seoConfig.extraGenerators || []);
+    this.generators = (
+      seoConfig.generators || [TextTags, ImageTags, AuthorTags, StaticTags, StructuredDataTags, StoryAmpTags]
+    ).concat(seoConfig.extraGenerators || []);
   }
 
   getMetaTags(config, pageType, data, params = {}) {
     pageType = get(this.seoConfig, ["pageTypeAliases", pageType], pageType);
-    return new MetaTagList(flatMap(this.generators, generator => generator(this.seoConfig, config, pageType, data, params)));
+    return new MetaTagList(
+      flatMap(this.generators, (generator) => generator(this.seoConfig, config, pageType, data, params))
+    );
   }
 
   getTitle(config, pageType, data, params = {}) {

package/package.json

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

package/src/amp-tags.js

@@ -1,12 +1,12 @@
-import get from 'lodash/get';
-import { isStoryPublic } from './utils';
+import get from "lodash/get";
+import { isStoryPublic } from "./utils";
 
 function showAmpTag({ ampStoryPages = true }, pageType, story) {
-  if (!ampStoryPages || pageType !== 'story-page') {
+  if (!ampStoryPages || pageType !== "story-page") {
     return false;
   }
 
-  if (ampStoryPages === 'public' && !isStoryPublic(story)) {
+  if (ampStoryPages === "public" && !isStoryPublic(story)) {
     return false;
   }
 
@@ -14,14 +14,13 @@ function showAmpTag({ ampStoryPages = true }, pageType, story) {
 }
 
 const getDomain = (url, domainSlug) => {
-  const domain = domainSlug ? new URL(url).origin : '';
+  const domain = domainSlug ? new URL(url).origin : "";
   try {
     return domain;
+  } catch (err) {
+    return "";
   }
-  catch (err) {
-    return ""
-  }
-}
+};
 
 /**
  * StoryAmpTags adds the amphref to stories which support amp.
@@ -34,20 +33,27 @@ const getDomain = (url, domainSlug) => {
  * @param {...*} params See {@link Generator} for other Parameters
  */
 export function StoryAmpTags(seoConfig, config, pageType, data = {}, opts) {
-
   const story = get(data, ["data", "story"], {});
-  const { currentHostUrl = '', domainSlug } = data;
+  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}`;
-
-  if (showAmpTag(seoConfig, pageType, story)) {
-    return [{
-      tag: 'link',
-      rel: 'amphtml',
-      href: ampUrl
-    }];
+  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"]);
+  if (showAmpTag(seoConfig, pageType, story) && !ignoreStoryTemplate) {
+    return [
+      {
+        tag: "link",
+        rel: "amphtml",
+        href: ampUrl,
+      },
+    ];
   } else {
     return [];
   }