Merge branch 'main' into front/fix-dark-light-mode

Author: addisonschultz

.changeset/dull-seas-repeat.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/integration-freshdesk': minor
+---
+
+Update Freshdesk configuration options

integrations/freshdesk/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @gitbook/integration-freshdesk
 
+## 1.0.1
+
+### Patch Changes
+
+- Switch configuration from widget ID to full widget URL, and inject that URL directly to support regional Freshworks widget domains.
+
 ## 1.0.0
 
 ### Major Changes

integrations/freshdesk/gitbook-manifest.yaml

@@ -19,12 +19,12 @@ organization: gitbook
 contentSecurityPolicy:
     font-src: |
         freshdesk.com
-        https://widget.freshworks.com;
+        *.freshworks.com;
     script-src: |
-        widget.freshworks.com;
+        *.freshworks.com;
     style-src: |
         freshdesk.com
-        https://widget.freshworks.com;
+        *.freshworks.com;
 summary: |
     # Overview
 
@@ -36,7 +36,7 @@ summary: |
 
     # Configure
 
-    You can configure the integration on single or multiple public sites by navigating to the integrations in sub-navigation or org settings. You will then have to provide Freshdesk widget ID to finish the configuration. This can be found in your Freshdesk dashboard, under the Widget section.
+    You can configure the integration on single or multiple public sites by navigating to the integrations in sub-navigation or org settings. You will then have to provide the full Freshdesk widget URL to finish the configuration. You can find this in your Freshworks account from the Embed Widget option.
 
 categories:
     - analytics
@@ -45,8 +45,8 @@ configurations:
         properties:
             widget_id:
                 type: string
-                title: Freshdesk Widget ID
-                description: Available in your Freshdesk dashboard, under the Widget section
+                title: Widget URL
+                description: Paste either your Freshdesk widget ID or the full widget URL from Freshworks Embed Widget.
         required:
             - widget_id
 target: site

integrations/freshdesk/src/index.ts

@@ -16,20 +16,53 @@ type FreshdeskRuntimeContext = RuntimeContext<
     >
 >;
 
+function parseWidgetConfiguration(
+    widgetInput?: string,
+): { widgetId: string; widgetURL: string } | null {
+    if (!widgetInput?.trim()) {
+        return null;
+    }
+
+    const value = widgetInput.trim();
+
+    try {
+        const parsedURL = new URL(value);
+        const widgetId = parsedURL.pathname.match(/\/widgets\/([^/]+)\.js$/)?.[1];
+        if (!widgetId) {
+            return null;
+        }
+
+        return {
+            widgetId,
+            widgetURL: parsedURL.toString(),
+        };
+    } catch {
+        return {
+            widgetId: value,
+            widgetURL: `https://widget.freshworks.com/widgets/${value}.js`,
+        };
+    }
+}
+
 export const handleFetchEvent: FetchPublishScriptEventCallback = async (
     event,
     { environment }: FreshdeskRuntimeContext,
 ) => {
-    const widgetId = environment.siteInstallation?.configuration?.widget_id;
-    if (!widgetId) {
+    const widgetInput = environment.siteInstallation?.configuration?.widget_id;
+    const widgetConfig = parseWidgetConfiguration(widgetInput);
+    if (!widgetConfig) {
         throw new Error(
-            `The Freshdesk Widget ID is missing from the configuration (ID: ${
+            `The Freshdesk widget configuration is invalid. Expected a widget ID or a full URL ending with /widgets/<widget_id>.js (ID: ${
                 'spaceId' in event ? event.spaceId : event.siteId
             }).`,
         );
     }
 
-    return new Response((script as string).replaceAll('<TO_REPLACE>', widgetId), {
+    const scriptContent = (script as string)
+        .replaceAll('<WIDGET_ID>', widgetConfig.widgetId)
+        .replaceAll('<WIDGET_URL>', widgetConfig.widgetURL);
+
+    return new Response(scriptContent, {
         headers: {
             'Content-Type': 'application/javascript',
             'Cache-Control': 'max-age=604800',

integrations/freshdesk/src/script.raw.js

@@ -1,5 +1,5 @@
 window.fwSettings = {
-    widget_id: '<TO_REPLACE>',
+    widget_id: '<WIDGET_ID>',
 };
 !(function () {
     if ('function' != typeof window.FreshworksWidget) {
@@ -14,7 +14,7 @@ window.fwSettings = {
 (function () {
     var s = document.createElement('script');
     s.type = 'text/javascript';
-    s.src = 'https://widget.freshworks.com/widgets/<TO_REPLACE>.js';
+    s.src = '<WIDGET_URL>';
     s.async = true;
     s.defer = true;
     document.getElementsByTagName('head')[0].appendChild(s);