@gitbook/adaptive (#808)

* WIP

* put in devdeps

* client folder

* review

* simplify

* remove export

* package version

* changeset

Author: taranvohra

.changeset/solid-wasps-switch.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/adaptive': patch
+---
+
+Initial version of @gitbook/adaptive

bun.lock

@@ -0,0 +1 @@
+dist

packages/adaptive/.gitignore

@@ -0,0 +1,30 @@
+const esbuild = require('esbuild');
+
+// Common settings
+const commonSettings = {
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    minify: true,
+    sourcemap: true,
+    target: ['es2020', 'chrome70', 'firefox70', 'safari12', 'edge79'],
+    plugins: [],
+    logLevel: 'info',
+};
+
+// Build ESM module
+esbuild
+    .build({
+        ...commonSettings,
+        outfile: 'dist/index.js',
+        format: 'esm',
+    })
+    .catch(() => process.exit(1));
+
+// Build CommonJS module
+esbuild
+    .build({
+        ...commonSettings,
+        outfile: 'dist/index.cjs',
+        format: 'cjs',
+    })
+    .catch(() => process.exit(1));

packages/adaptive/esbuild.config.js

@@ -0,0 +1,34 @@
+{
+    "name": "@gitbook/adaptive",
+    "description": "Utility to use adaptive content in GitBook",
+    "type": "module",
+    "version": "0.0.0",
+    "sideEffects": false,
+    "files": [
+        "README.md",
+        "dist/**"
+    ],
+    "dependencies": {
+        "js-cookie": "^3.0.5"
+    },
+    "devDependencies": {
+        "@gitbook/tsconfig": "*",
+        "typescript": "^5.6.2",
+        "@bucketco/browser-sdk": "^3.1.2",
+        "@types/js-cookie": "^3.0.6",
+        "esbuild": "^0.25.3"
+    },
+    "scripts": {
+        "build": "bun esbuild.config.js && tsc --emitDeclarationOnly",
+        "typecheck": "tsc --noEmit"
+    },
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "default": "./dist/index.cjs",
+            "require": "./dist/index.cjs",
+            "types": "./dist/index.d.ts"
+        },
+        "./package.json": "./package.json"
+    }
+}

packages/adaptive/package.json

@@ -0,0 +1,48 @@
+import type { BucketClient } from '@bucketco/browser-sdk';
+import { writeGitBookVisitorCookie } from './utils';
+
+/**
+ * Sets a client-side session cookie with the features enabled in the bucket client.
+ */
+export function withBucket(client: BucketClient): () => void {
+    const handler = () => {
+        const features: Record<string, boolean> = {};
+        // Check features enabled in the client
+        for (const [key, value] of Object.entries(client.getFeatures())) {
+            const enabled =
+                typeof value.isEnabledOverride === 'boolean'
+                    ? value.isEnabledOverride
+                    : value.isEnabled;
+            features[key] = enabled;
+        }
+
+        writeGitBookVisitorCookie('bucket', features);
+    };
+
+    // Determine if we're in a browser environment
+    const isBrowser = typeof window !== 'undefined';
+
+    if (!isBrowser) {
+        console.warn('withBucket was called in a non-browser environment');
+        return () => {};
+    }
+
+    const cleanup: Array<() => void> = [];
+
+    // Add event listener for when the DOM is ready
+    if (document.readyState === 'interactive' || document.readyState === 'complete') {
+        handler();
+    } else {
+        document.addEventListener('DOMContentLoaded', handler);
+        cleanup.push(() => {
+            document.removeEventListener('DOMContentLoaded', handler);
+        });
+    }
+    // Add event listeners for feature updates
+    cleanup.push(client.on('featuresUpdated', handler));
+
+    // Return cleanup function
+    return () => {
+        cleanup.forEach((fn) => fn());
+    };
+}

packages/adaptive/src/bucket.ts

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

packages/adaptive/src/index.ts

@@ -0,0 +1,22 @@
+import Cookies from 'js-cookie';
+
+const GITBOOK_VISITOR_PUBLIC_PREFIX = 'gitbook-visitor-public' as const;
+
+/**
+ * Write a client-side cookie for the GitBook visitor.
+ */
+export function writeGitBookVisitorCookie(name: string, value: unknown) {
+    const COOKIE_NAME = `${GITBOOK_VISITOR_PUBLIC_PREFIX}-${name}`;
+    const COOKIE_VALUE = (() => {
+        try {
+            return typeof value === 'string' ? value : JSON.stringify(value);
+        } catch (e) {
+            console.error('Error serializing value for cookie: ', e);
+            throw e;
+        }
+    })();
+
+    Cookies.set(COOKIE_NAME, COOKIE_VALUE, {
+        secure: true,
+    });
+}

packages/adaptive/src/utils.ts

@@ -0,0 +1,12 @@
+{
+    "extends": "@gitbook/tsconfig/base.json",
+    "include": ["src/**/*"],
+    "rootDir": "./src",
+    "compilerOptions": {
+        "outDir": "./dist",
+        "baseUrl": "./src",
+        "allowImportingTsExtensions": false,
+        "noEmit": false,
+        "declaration": true
+    }
+}