@c15t/scripts 2.2.0 → 3.0.0-alpha.0

package/docs/integrations/databuddy.md

@@ -1,205 +1,311 @@
 ---
 title: Databuddy
-description: Databuddy is a privacy-focused analytics platform that helps you
-  understand user behavior and track events. It supports cookieless tracking and
-  manages consent automatically through c15t's consent state synchronization.
-icon: databuddy
+description: Configure Databuddy's initial and updated consent state with c15t v3.
 group: integrations
 ---
-The Databuddy script automatically respects consent preferences by toggling tracking on and off based on the user's consent state.
 
-## Integrate with c15t
+## Configure Databuddy
 
-**React**
+Use the client ID for your Databuddy project. Supply both configuration objects
+so the initial script load has an explicit allowed and denied state.
 
-```tsx
-import { type ReactNode } from 'react';
-import { ConsentManagerProvider } from '@c15t/react';
+| Package manager | Command                     |
+| :-------------- | :-------------------------- |
+| npm             | `npm install @c15t/scripts` |
+| pnpm            | `pnpm add @c15t/scripts`    |
+| yarn            | `yarn add @c15t/scripts`    |
+| bun             | `bun add @c15t/scripts`     |
+
+```ts title="src/consent-scripts.ts"
 import { databuddy } from '@c15t/scripts/databuddy';
 
-const scripts = [
+export const scripts = [
   databuddy({
-    clientId: 'your-client-id',
-    scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
-    apiUrl: 'https://basket.databuddy.cc',
-    configWhenGranted: {
-      clientId: 'your-client-id',
-      apiUrl: 'https://basket.databuddy.cc',
-      disabled: false,
-    },
-    configWhenDenied: {
-      clientId: 'your-client-id',
-      apiUrl: 'https://basket.databuddy.cc',
-      disabled: true,
-    },
+    clientId: 'YOUR_CLIENT_ID',
+    configWhenGranted: { disabled: false },
+    configWhenDenied: { disabled: true },
   }),
 ];
-
-export function ConsentProvider({ children }: { children: ReactNode }) {
-  return (
-    <ConsentManagerProvider
-      options={{
-        mode: 'hosted',
-        backendURL: 'https://your-instance.c15t.dev',
-        scripts,
-      }}
-    >
-      {children}
-    </ConsentManagerProvider>
-  );
-}
 ```
 
+## Register the scripts
+
+Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
+endpoint, policy, styles and consent UI. Remove the vendor's original script,
+SDK initializer or tag-manager entry so c15t owns loading once.
+
+The `scripts` export in `src/consent-scripts.ts` is a configuration, not an
+initializer. Add it to your existing consent owner using the registration point
+below. These are partial edits to that owner, not additional providers.
+
 **Next.js**
 
+Import the configuration into the client boundary from your router guide:
+
+```ts
+import { ConsentRoot } from 'c15t/next';
+import { scripts } from './consent-scripts';
+```
+
+Keep the server-resolved `state` and shared `consentConfig` from your
+router guide. Its manifest, init and save URLs stay in effect. Add
+`scripts` as a top-level prop on the existing root:
+
 ```tsx
-'use client';
+<ConsentRoot state={state} config={consentConfig} scripts={scripts}>
+  {children}
+</ConsentRoot>
+```
 
-import { type ReactNode } from 'react';
-import { ConsentManagerProvider } from '@c15t/nextjs';
-import { databuddy } from '@c15t/scripts/databuddy';
+For a Pages Router or static-export setup using `ConsentProvider`, add
+`scripts` to its existing `options` instead. Keep the router-specific setup
+from [Next.js script loading](../frameworks/next/script-loader.md).
 
-const scripts = [
-  databuddy({
-    clientId: 'your-client-id',
-    scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
-    apiUrl: 'https://basket.databuddy.cc',
-    configWhenGranted: {
-      clientId: 'your-client-id',
-      apiUrl: 'https://basket.databuddy.cc',
-      disabled: false,
-    },
-    configWhenDenied: {
-      clientId: 'your-client-id',
-      apiUrl: 'https://basket.databuddy.cc',
-      disabled: true,
-    },
-  }),
-];
+**TanStack Start**
+
+In your existing root route component, import the scripts alongside
+`ConsentRoot`. Keep the server loader from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart).
+
+```tsx
+import { Outlet } from '@tanstack/react-router';
+import { ConsentRoot } from 'c15t/tanstack-start';
+import { scripts } from '../consent-scripts';
 
-export function ConsentProvider({ children }: { children: ReactNode }) {
+function Root() {
+  const state = Route.useLoaderData();
   return (
-    <ConsentManagerProvider
-      options={{
-        mode: 'hosted',
-        backendURL: '/api/c15t',
-        scripts,
-      }}
-    >
-      {children}
-    </ConsentManagerProvider>
+    <ConsentRoot state={state} backendURL={backendURL} initRoute={false} scripts={scripts}>
+      <Outlet />
+      {/* Keep your consent banner, dialog and preferences link here. */}
+    </ConsentRoot>
   );
 }
 ```
 
-**JavaScript**
+This edits the existing route. `Route` and `backendURL` come from its setup;
+keep the document shell and head components if they are part of your root.
+`initRoute={false}` keeps the quickstart's direct-backend initialization.
+If your app mounts a consent server route, retain its existing `initRoute`
+instead. Do not return script callbacks from a server function or route loader.
+
+**React**
+
+Import the scripts into your existing provider component:
 
 ```ts
-import { getOrCreateConsentRuntime } from 'c15t';
-import { databuddy } from '@c15t/scripts/databuddy';
+import { ConsentProvider } from 'c15t/react';
+import { scripts } from './consent-scripts';
+```
+
+Keep the existing options and add `scripts`:
+
+```tsx
+<ConsentProvider options={{ ...consentOptions, scripts }}>
+  {children}
+</ConsentProvider>
+```
+
+Here `consentOptions` is your existing configuration, including
+`mode: hosted({ url: backendURL })`. Keep the banner, dialog and preferences
+link inside the provider. See [React script loading](../frameworks/react/script-loader.md).
+
+**Nuxt**
+
+Attach one loader from the root `app.vue`, after the Nuxt module has
+started its browser runtime. This keeps vendor callbacks in application code rather
+than serialized `nuxt.config.ts` runtime configuration.
 
-getOrCreateConsentRuntime({
-  mode: 'hosted',
-  backendURL: 'https://your-instance.c15t.dev',
-  scripts: [
-    databuddy({
-      clientId: 'your-client-id',
-      scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
-      apiUrl: 'https://basket.databuddy.cc',
-      configWhenGranted: {
-        clientId: 'your-client-id',
-        apiUrl: 'https://basket.databuddy.cc',
-        disabled: false,
-      },
-      configWhenDenied: {
-        clientId: 'your-client-id',
-        apiUrl: 'https://basket.databuddy.cc',
-        disabled: true,
-      },
-    }),
-  ],
+```vue title="app/app.vue"
+<script setup lang="ts">
+import { onUnmounted } from 'vue';
+import { createScriptLoader } from 'c15t/modules/script-loader';
+import { scripts } from '../src/consent-scripts';
+
+const nuxtApp = useNuxtApp();
+const kernel = useConsentKernel();
+let loader: ReturnType<typeof createScriptLoader> | undefined;
+
+const removeMountedHook = nuxtApp.hook('app:mounted', () => {
+  loader = createScriptLoader({ kernel, scripts });
+});
+onUnmounted(() => {
+  removeMountedHook();
+  loader?.dispose();
 });
+</script>
+
+<template>
+  <ConsentRoot />
+  <NuxtPage />
+</template>
 ```
 
-## How c15t loads it
+Merge the setup code into your root and retain its footer and preferences
+link. `useConsentKernel` is auto-imported by the c15t Nuxt module. Adjust the
+relative script import if your `app.vue` is at the project root. This loader
+waits until the module has applied browser persistence and privacy signals,
+then reads the current snapshot and observes future changes. Do not also register these scripts
+in another loader. See the [Nuxt quickstart](https://c15t.com/docs/frameworks/nuxt/quickstart).
 
-* **Category:** `measurement` (Analytics)
-* **Loads when:** [`alwaysLoad`](/docs/frameworks/react/script-loader#always-load) — runs on page start regardless of consent state
-* **On consent change:** c15t toggles `window.databuddy.options.disabled` so tracking turns on or off without removing the script
+**Vue**
 
-## Configure the integration
+Use the kernel already provided by the Vue plugin. Merge this setup into
+`App.vue`, whose lifetime covers the application:
 
-The Databuddy manifest expects explicit initial config objects for the granted
-and denied consent states:
+```vue title="src/App.vue"
+<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue';
+import { createScriptLoader } from 'c15t/modules/script-loader';
+import { useConsentKernel } from 'c15t/vue/vue-plugin';
+import ConsentRoot from 'c15t/vue/consent-root';
+import { scripts } from './consent-scripts';
 
-```ts
-databuddy({
-  clientId: 'your-client-id',
-  scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
-  apiUrl: 'https://basket.databuddy.cc', // Optional, defaults to basket.databuddy.cc, change if self-hosting
-  configWhenGranted: {
-    clientId: 'your-client-id',
-    apiUrl: 'https://basket.databuddy.cc',
-    // Tracking options
-    trackScreenViews: true,        // Automatically track page views
-    trackOutgoingLinks: true,      // Track clicks on external links
-    trackAttributes: false,        // Track data-track attributes on elements
-    trackErrors: false,            // Track JavaScript errors
-    trackPerformance: true,        // Track performance metrics
-    trackWebVitals: false,         // Track Core Web Vitals
-
-
-    // Network options
-    enableBatching: false,         // Batch events before sending
-    batchSize: 10,                 // Events per batch
-    batchTimeout: 2000,            // Batch timeout in ms
-    samplingRate: 1.0,             // Sample rate (0.0-1.0)
-    disabled: false,
-  },
-  configWhenDenied: {
-    clientId: 'your-client-id',
-    apiUrl: 'https://basket.databuddy.cc',
-    disabled: true,
-  }
-})
+const kernel = useConsentKernel();
+let loader: ReturnType<typeof createScriptLoader> | undefined;
+
+onMounted(() => {
+  loader = createScriptLoader({ kernel, scripts });
+});
+onUnmounted(() => loader?.dispose());
+</script>
+
+<template>
+  <ConsentRoot />
+  <main>Your application</main>
+</template>
 ```
 
-## Tracking events in your app
+Keep your existing page content and preferences link. The plugin still owns
+the kernel and persistence; this component owns only the vendor loader.
+Do not register the same scripts in plugin configuration as well. See the
+[Vue quickstart](https://c15t.com/docs/frameworks/vue/quickstart).
 
-Databuddy is `alwaysLoad: true`, so the script is in the DOM from page start regardless of consent. `window.databuddy` is therefore always defined and calls to `track`, `screenView`, or `setGlobalProperties` are safe to make at any time — when measurement consent is denied, c15t flips `window.databuddy.options.disabled = true` so the SDK becomes a no-op until consent is granted again.
+**Astro**
 
-```ts
-window.databuddy?.track('signup');
+Point the existing Astro integration at a client module. Keep its `mode`,
+`ui` and framework integration from the [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart).
+Import `fileURLToPath` in your Astro configuration:
+
+```js title="astro.config.mjs"
+import { fileURLToPath } from 'node:url';
+```
+
+Add this option to the existing `c15t({ ... })` call. Resolve the path from
+the configuration file because Astro injects the import into a virtual module:
+
+```js
+clientEntrypoint: fileURLToPath(new URL('./src/c15t.client.ts', import.meta.url)),
+```
+
+Export the scripts from that module:
+
+```ts title="src/c15t.client.ts"
+import type { C15tClientOptionsExtension } from '@c15t/astro';
+import { scripts } from './consent-scripts';
+
+export default { scripts } satisfies C15tClientOptionsExtension;
+```
+
+The integration passes this extension to its shared browser runtime. Vendor
+helpers contain callbacks, so do not put them in the serialized `scripts`
+option in `astro.config.mjs`. Keep one runtime across consent islands and
+`ClientRouter` navigation.
+
+**Svelte**
+
+Import the scripts in the component that owns your existing provider and
+pass them as a top-level prop:
+
+```svelte title="src/App.svelte"
+<script lang="ts">
+  import { ConsentManagerProvider, hosted } from '@c15t/svelte';
+  import { scripts } from './consent-scripts';
+
+  const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
+  if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
+  const mode = hosted({ url: backendURL });
+</script>
+
+<ConsentManagerProvider {mode} {scripts}>
+  <!-- Keep your application, consent UI and preferences link here. -->
+</ConsentManagerProvider>
+```
+
+Retain the styles and consent UI from the [Svelte quickstart](https://c15t.com/docs/frameworks/svelte/quickstart).
+The provider owns the loader and disposes it on unmount.
+
+**SvelteKit**
+
+Add the scripts to the existing root layout provider. Keep the server load
+and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.com/docs/frameworks/sveltekit/quickstart).
+
+```svelte title="src/routes/+layout.svelte"
+<script lang="ts">
+  import { ConsentManagerProvider, hosted } from '@c15t/svelte';
+  import { scripts } from '../consent-scripts';
+
+  let { children, data } = $props();
+  const mode = hosted({ url: data.backendURL });
+</script>
+
+<ConsentManagerProvider {mode} {scripts} prefetch={data.prefetch}>
+  {@render children()}
+  <!-- Keep your consent UI and preferences link here. -->
+</ConsentManagerProvider>
 ```
 
-You do not need to guard these calls with `useConsentManager().has('measurement')`, but doing so does no harm if you prefer the symmetry with other vendors.
+Import vendor helpers in the layout component, not in `+layout.server.ts`.
+For static hosting, keep your browser-only `mode` setup and omit request
+prefetch; the `scripts` prop stays the same. If you pass an externally owned
+`runtime` to the provider, register scripts when creating that runtime instead.
 
-## Consent and privacy
+**JavaScript**
 
-The Databuddy integration automatically handles consent management:
+Attach the loader to your existing kernel before calling
+`kernel.commands.init()`:
+
+```ts
+import { createScriptLoader } from 'c15t/modules/script-loader';
+import { scripts } from './consent-scripts';
+
+const loader = createScriptLoader({ kernel, scripts });
+```
 
-1. **Before Script Load**: Sets `window.databuddyConfig.disabled` based on initial consent state
-2. **On Consent Grant**: Enables tracking by setting `window.databuddy.options.disabled = false`
-3. **On Consent Revoke**: Disables tracking by setting `window.databuddy.options.disabled = true`
+Call `loader.dispose()` when that application instance is destroyed.
+`kernel` is the hosted kernel from your quickstart. A provider-owned kernel
+already has a loader; do not attach a second one. See
+[JavaScript script loading](../frameworks/javascript/script-loader.md).
 
-This ensures that no tracking occurs without user consent, keeping your analytics privacy-compliant.
+## Options
 
-## Types
+| Option              | Behavior                                                 |
+| ------------------- | -------------------------------------------------------- |
+| `clientId`          | Required project client ID.                              |
+| `configWhenGranted` | Required configuration used when measurement is allowed. |
+| `configWhenDenied`  | Required configuration used when measurement is denied.  |
+| `apiUrl`            | Defaults to `https://basket.databuddy.cc`.               |
+| `scriptUrl`         | Defaults to `https://cdn.databuddy.cc/databuddy.js`.     |
 
-### DatabuddyConsentOptions
+Use serializable configuration values. The helper seeds
+`window.databuddyConfig` before loading only if that global is absent. Remove a
+separate global initializer that could override your intended initial state.
 
-|Property|Value|
-|:--|:--|
-|Type Name|\`DatabuddyConsentOptions\`|
-|Source Path|\`./packages/scripts/src/vendors/analytics/databuddy.ts\`|
+## Consent behavior
 
-\*ExtractedTypeTable: Could not extract "DatabuddyConsentOptions" from "./packages/scripts/src/vendors/analytics/databuddy.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
+Databuddy uses `alwaysLoad: true`. The script is requested regardless of
+measurement permission. On load and later changes, the helper sets
+`window.databuddy.options.disabled` from measurement permission. On consent
+changes it also replaces `window.databuddyConfig` with the matching object.
 
-### Script
+This helper is not a no-request-before-consent integration. If your requirement
+is to prevent even the SDK request, use a
+[custom gated integration](./building-integrations.md) and verify
+its complete lifecycle.
 
-|Property|Value|
-|:--|:--|
-|Type Name|\`Script\`|
-|Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
+## Verify the integration
 
-\*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
+Expect the loader request while consent is denied. Check the initial global
+configuration and the SDK's `disabled` value, grant measurement, then revoke it.
+Confirm collection follows those transitions and that application event calls
+stop after revocation. Test with no pre-existing `databuddyConfig` as well as
+with persisted consent. See [consent verification](../guides/verify-consent.md).