Finish integration, add changeset

Author: addisonschultz

.changeset/hot-ads-decide.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/integration-helpscout': major
+---
+
+This change releases the first version of the HelpScout integration for GitBook

integrations/helpscout/assets/helpscout-preview.png

@@ -2,13 +2,30 @@ name: helpscout
 title: HelpScout
 organization: gitbook
 visibility: public
-description: ''
+description: Add the HelpScout chat widget to your published GitBook content
+summary: |
+    # Overview
+
+    The HelpScout integration for GitBook allows you to display the HelpScout chat widget on your public documentation to connect and interact with your readers.
+
+    # How it works
+
+    Automatic chat widget on your documentation: Each of your connected GitBook spaces will fetch the HelpScout chat widget script and add it to your published content.
+
+    # Configure
+
+    You can configure the integration on single or multiple public spaces by navigating to the integrations in sub-navigation or org settings. You will then have to provide HelpScout ID to finish the configuration.
+categories:
+    - analytics
 script: src/index.tsx
-scopes: []
-blocks:
-    - id: helpscout
-      title: HelpScout
-      description: My GitBook Integration
+icon: ./assets/icon.png
+previewImages:
+    - assets/helpscout-preview.png
+# The following scope(s) are available only to GitBook Staff
+# See https://developer.gitbook.com/integrations/configurations#scopes
+scopes:
+    - space:script:inject
+    - site:script:inject
 secrets: {}
 contentSecurityPolicy:
     script-src: https://beacon-v2.helpscout.net;
@@ -17,15 +34,15 @@ configurations:
         properties:
             helpscout_id:
                 type: string
-                title: Koala Key
+                title: HelpScout ID
                 description: Your HelpScout integration ID.
         required:
             - helpscout_id
     site:
         properties:
             helpscout_id:
                 type: string
-                title: Koala Key
+                title: HelpScout ID
                 description: Your HelpScout integration ID.
         required:
             - helpscout_id

integrations/helpscout/assets/icon.png

@@ -1,6 +1,7 @@
 {
-    "name": "helpscout",
+    "name": "@gitbook/integration-helpscout",
     "private": true,
+    "version": "0.0.1",
     "scripts": {
         "lint": "eslint --ext .js,.jsx,.ts,.tsx .",
         "typecheck": "tsc --noEmit",
@@ -14,4 +15,4 @@
         "@gitbook/eslint-config": "*",
         "@gitbook/tsconfig": "*"
     }
-}
+}

integrations/helpscout/gitbook-manifest.yaml

@@ -20,16 +20,16 @@ export const handleFetchEvent: FetchPublishScriptEventCallback = async (
     event,
     { environment }: HelpScoutRuntimeContext
 ) => {
-    const koalaId =
+    const helpscoutID =
         environment.spaceInstallation.configuration.helpscout_id ??
         environment.siteInstallation?.configuration?.helpscout_id ??
-        'Koala Key not configured';
+        'HelpScout ID not configured';
 
-    if (!koalaId) {
+    if (!helpscoutID) {
         return;
     }
 
-    return new Response(script.replace('<TO_REPLACE>', koalaId), {
+    return new Response(script.replace('<TO_REPLACE>', helpscoutID), {
         headers: {
             'Content-Type': 'application/javascript',
             'Cache-Control': 'max-age=604800',