Add withLaunchDarkly helper function (#848)

* withLaunchDarkly

* changeset

* refactor

Author: taranvohra

.changeset/cold-taxes-hunt.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/adaptive': minor
+---
+
+Add `withLaunchDarkly` helper function

bun.lock

@@ -568,12 +568,13 @@
         "@gitbook/tsconfig": "*",
         "@types/js-cookie": "^3.0.6",
         "esbuild": "^0.25.3",
+        "launchdarkly-js-client-sdk": "^3.8.1",
         "typescript": "^5.6.2",
       },
     },
     "packages/api": {
       "name": "@gitbook/api",
-      "version": "0.117.0",
+      "version": "0.119.0",
       "dependencies": {
         "event-iterator": "^2.0.0",
         "eventsource-parser": "^3.0.0",
@@ -588,7 +589,7 @@
     },
     "packages/cli": {
       "name": "@gitbook/cli",
-      "version": "0.23.0",
+      "version": "0.24.0",
       "bin": {
         "gitbook": "./cli.js",
       },
@@ -1594,7 +1595,7 @@
 
     "fast-content-type-parse": ["[email protected]", "", {}, "sha512-nGqtvLrj5w0naR6tDPfB4cUmYCqouzyQiz6C5y/LtcDllJdrcc6WaWW6iXyIIOErTa/XRybj28aasdn4LkVk6Q=="],
 
-    "fast-deep-equal": ["fast-deep-equal@3.1.3", "", {}, "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="],
+    "fast-deep-equal": ["fast-deep-equal@2.0.1", "", {}, "sha512-bCK/2Z4zLidyB4ReuIsvALH6w31YfAQDmXMqMx6FyfHqvBxtjC0eRumeSu4Bs3XtXwpyIywtSTrVT99BxY1f9w=="],
 
     "fast-glob": ["[email protected]", "", { "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", "micromatch": "^4.0.8" } }, "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg=="],
 
@@ -1862,6 +1863,10 @@
 
     "kleur": ["[email protected]", "", {}, "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w=="],
 
+    "launchdarkly-js-client-sdk": ["[email protected]", "", { "dependencies": { "escape-string-regexp": "^4.0.0", "launchdarkly-js-sdk-common": "5.7.1" } }, "sha512-Y05FXM8FAXAMbbJqeI+ffr6a4m2M/TBUccgI9ejWPSxQS+/b2t+FBWZzfmc7wXuOOYzgGkpHHfQ6bFDU9NKPWQ=="],
+
+    "launchdarkly-js-sdk-common": ["[email protected]", "", { "dependencies": { "base64-js": "^1.3.0", "fast-deep-equal": "^2.0.1", "uuid": "^8.0.0" } }, "sha512-RFFeoYVL764zarFpU16lDt1yHzUCt0rnYYKlX5LLtZ5Nhq+2fzE33xRolP/sjxAYVInD0o5z6jKTlDe8gtcDYg=="],
+
     "lines-and-columns": ["[email protected]", "", {}, "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="],
 
     "listr2": ["[email protected]", "", { "dependencies": { "cli-truncate": "^2.1.0", "colorette": "^2.0.16", "log-update": "^4.0.0", "p-map": "^4.0.0", "rfdc": "^1.3.0", "rxjs": "^7.5.5", "through": "^2.3.8", "wrap-ansi": "^7.0.0" }, "peerDependencies": { "enquirer": ">= 2.3.0 < 3" }, "optionalPeers": ["enquirer"] }, "sha512-juGHV1doQdpNT3GSTs9IUN43QJb7KHdF9uqg7Vufs/tG9VTzpFphqF4pm/ICdAABGQxsyNn9CiYA3StkI6jpwA=="],
@@ -2352,6 +2357,8 @@
 
     "util-deprecate": ["[email protected]", "", {}, "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="],
 
+    "uuid": ["[email protected]", "", { "bin": { "uuid": "dist/bin/uuid" } }, "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="],
+
     "validate-npm-package-name": ["[email protected]", "", {}, "sha512-OljLrQ9SQdOUqTaQxqL5dEfZWrXExyyWsozYlAWFawPVNuD83igl7uJD2RTkNMbniIYgt8l81eCJGIdQF7avLQ=="],
 
     "wcwidth": ["[email protected]", "", { "dependencies": { "defaults": "^1.0.3" } }, "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg=="],
@@ -2556,6 +2563,8 @@
 
     "@whatwg-node/fetch/urlpattern-polyfill": ["[email protected]", "", {}, "sha512-H/A06tKD7sS1O1X2SshBVeA5FLycRpjqiBeqGKmBwBDBy28EnRjORxTNe269KSSr5un5qyWi1iL61wLxpd+ZOg=="],
 
+    "ajv/fast-deep-equal": ["[email protected]", "", {}, "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="],
+
     "ansi-escapes/type-fest": ["[email protected]", "", {}, "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w=="],
 
     "anymatch/picomatch": ["[email protected]", "", {}, "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA=="],

packages/adaptive/package.json

@@ -15,6 +15,7 @@
         "@gitbook/tsconfig": "*",
         "typescript": "^5.6.2",
         "@bucketco/browser-sdk": "^3.1.2",
+        "launchdarkly-js-client-sdk": "^3.8.1",
         "@types/js-cookie": "^3.0.6",
         "esbuild": "^0.25.3"
     },

packages/adaptive/src/index.ts

@@ -1,2 +1,3 @@
 export * from './bucket';
+export * from './launchdarkly';
 export { writeGitBookVisitorCookie } from './utils';

packages/adaptive/src/launchdarkly.ts

@@ -0,0 +1,64 @@
+import { writeGitBookVisitorCookie } from './utils';
+import type { LDClient } from 'launchdarkly-js-client-sdk';
+
+/**
+ * Sets a client-side session cookie with the features enabled in the Launchdarkly client.
+ */
+export function withLaunchDarkly(client: LDClient): () => void {
+    const handler = () => {
+        const features: Record<string, boolean> = {};
+        // Check features enabled in the client
+        for (const [key, value] of Object.entries(client.allFlags())) {
+            features[key] = value;
+        }
+
+        writeGitBookVisitorCookie('launchdarkly', { launchdarkly: features });
+    };
+
+    // Determine if we're in a browser environment
+    const isBrowser = typeof window !== 'undefined';
+
+    if (!isBrowser) {
+        console.warn('withLaunchDarkly was called in a non-browser environment');
+        return () => {};
+    }
+
+    // Always try to call handler immediately in case client is already initialized
+    // This is safe even if the client isn't ready yet
+    try {
+        handler();
+    } catch (error) {
+        // Ignore errors if client isn't ready yet
+        console.debug('LaunchDarkly client not ready yet, will wait for initialization');
+    }
+
+    const cleanup: Array<() => void> = [];
+
+    const onReadyOrLoad = () => {
+        client.on('initialized', handler);
+        cleanup.push(() => {
+            client.off('initialized', handler);
+        });
+    };
+
+    // Add event listener for when the DOM is ready
+    if (document.readyState === 'interactive' || document.readyState === 'complete') {
+        onReadyOrLoad();
+    } else {
+        document.addEventListener('DOMContentLoaded', onReadyOrLoad);
+        cleanup.push(() => {
+            document.removeEventListener('DOMContentLoaded', onReadyOrLoad);
+        });
+    }
+
+    // Add event listeners for feature updates
+    client.on('change', handler);
+    cleanup.push(() => {
+        client.off('change', handler);
+    });
+
+    // Return cleanup function
+    return () => {
+        cleanup.forEach((fn) => fn());
+    };
+}