@quintype/framework 7.34.4-qlitics-removal.0 → 7.34.4

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.
 
+### [7.34.4](https://github.com/quintype/quintype-node-framework/compare/v7.34.3...v7.34.4) (2025-07-21)
+
 ### [7.34.3](https://github.com/quintype/quintype-node-framework/compare/v7.34.2...v7.34.3) (2025-07-07)
 
 

package/client/analytics.js

@@ -1,10 +1,84 @@
 /**
- * Register a page view in Google Analytics. This method takes the page object, which is usually returned from *"/route-data.json"*.
+ * This namespace handles a number of analytics related functions.
+ * The vast majority of these features are already wired by default, but and are only required to be called manually if you are doing something special.
+ * By default, both GA and qlitics are tracked (including when pages are loaded via AJAX).
+ *
+ * The GA tracker looks for the default tracker, then looks for the tracker called `gtm1`. If you would like to disable GA tracking, set `window.qtNoAutomaticGATracking` to true.
+ *
+ * ```javascript
+ * import * from "@quintype/framework/client/analytics";
+ * ```
+ * @category Client
+ * @module analytics
+ */
+
+import get from "lodash/get";
+import { runWhenIdle } from "./impl/run-when-idle";
+
+/**
+ * Load qlitics.js. This should be done automatically for you
+ * @returns {void}
+ */
+// istanbul ignore next
+export function startAnalytics({ mountAt = global.qtMountAt || "" } = {}) {
+  global.qlitics =
+    global.qlitics ||
+    function () {
+      (qlitics.q = qlitics.q || []).push(arguments);
+    };
+  global.qlitics("init");
+
+  runWhenIdle(function () {
+    const s = document.createElement("script");
+    s.type = "text/javascript";
+    s.async = true;
+    s.src = `${mountAt}/qlitics.js`;
+    const x = document.getElementsByTagName("script")[0];
+    x.parentNode.insertBefore(s, x);
+  });
+}
+
+function pageTypeToQliticsPageType(pageType) {
+  switch (pageType) {
+    case "story-page":
+      return "story";
+    case "home-page":
+      return "home";
+    case "section-page":
+      return "section";
+    case "tag-page":
+      return "topic";
+    default:
+      return pageType;
+  }
+}
+
+/**
+ * Register a story view event. This should already be wired up for story pages, but this event can
+ * be fired on an infinite scroll event. Ideally, please use {@link registerPageView}
+ * @param {uuid} storyContentId
+ * @returns {void}
+ */
+export function registerStoryView(storyContentId) {
+  global.qlitics("track", "story-view", {
+    "story-content-id": storyContentId,
+  });
+}
+
+/**
+ * Register a page view in both qlitics and google analytics. This method takes the page object, which is usually returned from *"/route-data.json"*.
  * @param {Object} page ex: *{"page-type": "story-page", "story": {...}}*
  * @param {string} newPath ex: "/path/to/story"
  * @returns {void}
  */
 export function registerPageView(page, newPath) {
+  global.qlitics("track", "page-view", {
+    "page-type": pageTypeToQliticsPageType(page.pageType),
+  });
+  if (page.pageType == "story-page") {
+    registerStoryView(get(page.data, ["story", "id"]));
+  }
+
   if (newPath && global.ga && !global.qtNoAutomaticGATracking) {
     global.ga(function (tracker) {
       tracker = tracker || global.ga.getByName("gtm1");
@@ -14,3 +88,27 @@ export function registerPageView(page, newPath) {
     });
   }
 }
+
+/**
+ * Set the current member id on qlitics
+ * @param {number} memberId The member id of the logged in member
+ * @returns {void}
+ */
+export function setMemberId(memberId) {
+  global.qlitics("set", "member-id", memberId);
+}
+
+/**
+ * This event will register a social share of a story in qlitics
+ * @param {uuid} storyContentId The id of the story being shared
+ * @param {string} socialMediaType The social network the item is being shared on
+ * @param {string} storyUrl The canonical URL of the story
+ * @returns {void}
+ */
+export function registerStoryShare(storyContentId, socialMediaType, storyUrl) {
+  global.qlitics("track", "story-share", {
+    "story-content-id": storyContentId,
+    "social-media-type": socialMediaType,
+    url: storyUrl,
+  });
+}

package/client/start.js

@@ -16,7 +16,7 @@ import { Provider } from "react-redux";
 import { IsomorphicComponent } from "../isomorphic/component";
 import { makePickComponentSync } from "../isomorphic/impl/make-pick-component-sync";
 import { createQtStore } from "../store/create-store";
-import { registerPageView } from "./analytics";
+import { registerPageView, registerStoryShare, setMemberId, startAnalytics } from "./analytics";
 import { initializeFCM } from "./impl/fcm";
 import {
   checkForServiceWorkerUpdates,
@@ -40,9 +40,10 @@ export const app = {
   maybeNavigateTo,
   maybeSetUrl,
   registerPageView,
+  registerStoryShare,
+  setMemberId,
 };
 
-
 function getRouteDataAndPath(path, mountAt) {
   const relativePath = path.startsWith(mountAt) ? path.slice(mountAt.length) : path;
   return [`${mountAt || ""}/route-data.json`, relativePath];
@@ -247,7 +248,7 @@ function getJsonContent(id) {
   if (element) return JSON.parse(element.textContent);
 }
 
-const performance = window.performance || { mark: () => { }, measure: () => { } };
+const performance = window.performance || { mark: () => {}, measure: () => {} };
 function runWithTiming(name, f) {
   performance.mark(`${name}Start`);
   f();
@@ -277,6 +278,9 @@ export function startApp(renderApplication, reducers, opts) {
   const dataPromise = staticData
     ? Promise.resolve(staticData.qt)
     : getRouteData(path, { existingFetch: global.initialFetch });
+
+  startAnalytics();
+
   const store = createQtStore(
     reducers,
     (staticData && staticData.qt) || global.initialPage || getJsonContent("initial-page") || {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.34.4-qlitics-removal.0",
+  "version": "7.34.4",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -33,7 +33,7 @@
     "@ampproject/toolbox-optimizer": "2.8.3",
     "@grpc/grpc-js": "^1.12.5",
     "@jsdoc/salty": "^0.2.9",
-    "@quintype/amp": "^2.21.4",
+    "@quintype/amp": "^2.22.0",
     "@quintype/backend": "^2.7.0",
     "@quintype/components": "^3.5.0",
     "@quintype/prerender-node": "^3.2.26",

package/server/amp/handlers/story-page.js

@@ -57,7 +57,10 @@ async function ampStoryPageHandler(
     const story = await Story.getStoryBySlug(client, req.params["0"]);
     const isAmpDisabled = get(story, ["metadata", "story-attributes", "disable-amp-for-single-story", "0"], "false");
 
-    if (!isVisualStory && (!enableAmp || isAmpDisabled === "true")) {
+    const getDisableAmpUnit = get(opts, ["disableAmpUnit"], false);
+    const disableAmpUnit = typeof getDisableAmpUnit === "function" && opts.disableAmpUnit(story);
+
+    if (disableAmpUnit || (!isVisualStory && (!enableAmp || isAmpDisabled === "true"))) {
       const ampPageBasePath = getAmpPageBasePath(opts, config);
       const redirectUrl = `/${req.params[0]}`.startsWith(ampPageBasePath)
         ? `/${req.params[0]}`.replace(ampPageBasePath, "")

package/server/routes.js

@@ -680,6 +680,27 @@ exports.mountQuintypeAt = function (app, mountAt) {
  * To disable amp version 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". This will redirect '<amp-page-base-path>/:slug' to the non-amp page
  *
+ * To disable the AMP version for a specific story template or section, pass opts.disableAmpUnit as a function that always returns a boolean value. When the function returns true, AMP will be disabled for the specified scenario.
+ * Note: Ensure that disableAmpUnit is always a function and returns a boolean value, as demonstrated below.
+ *
+ *  Under app/server/app.js
+ *
+ * ``` const getTemplate = (story) => {
+ *       return story.["story-template"] === "template-name";
+ *       };
+ *
+ *   ....
+ *
+ *  ampRoutes(app, {
+ *    seo: generateSeo,
+ *     disableAmpUnit: (story) => getTemplate(story),
+ *     featureConfig: {
+ *     .....
+ *     }
+ *     ...
+ *    .....
+ * })```
+ *
  * @param {Express} app Express app to add the routes to
  * @param {Object} opts Options object used to configure amp. Passing this is optional
  * @param {Object} opts.templates An object that's used to pass custom templates. Each key corresponds to the template name and corresponding value is the template