@c15t/react 3.2.0-canary.0 → 3.2.0

package/docs/integrations/building-integrations.md

@@ -36,22 +36,22 @@ with your framework, follow any vendor guide, for example
 
 ## Script fields
 
-| Field                                           | Default                | Behavior                                                                                                              |
-| ----------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `id`                                            | Required               | Stable identifier. c15t tracks the script by it across renders.                                                       |
-| `category`                                      | Required               | A category name, or a condition such as `{ or: ['measurement', 'marketing'] }`, `{ and: [...] }` or `{ not: '...' }`. |
-| `src` / `textContent`                           | None                   | Set exactly one, unless `callbackOnly` is `true`.                                                                     |
-| `vendor`                                        | None                   | Vendor slug, so a visitor can turn this vendor off inside an allowed category.                                        |
-| `callbackOnly`                                  | `false`                | Run callbacks without adding a script element.                                                                        |
-| `alwaysLoad`                                    | `false`                | Load regardless of permission.                                                                                        |
-| `persistAfterConsentRevoked`                    | `false`                | Keep the script element when permission is revoked.                                                                   |
-| `onBeforeLoad`, `onLoad`, `onError`             | None                   | Run before the element is added, after it loads, and if it fails.                                                     |
-| `onConsentChange`                               | None                   | Runs when permissions change after the script has loaded, and when it is removed.                                     |
-| `onDispose`                                     | None                   | Runs when this configuration is removed or its loader is disposed. Revocation alone does not call it.                 |
-| `target`                                        | `'head'`               | `'head'` or `'body'`.                                                                                                 |
-| `async`, `defer`, `attributes`, `fetchPriority` | None                   | Copied to the script element.                                                                                         |
-| `nonce`                                         | The provider's `nonce` | Content Security Policy nonce for this element.                                                                       |
-| `anonymizeId`                                   | `true`                 | Use a random element ID. Set `false` for `c15t-script-<id>`.                                                          |
+| Field                                           | Default                | Behavior                                                                                                                                                                 |
+| ----------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                            | Required               | Stable identifier. c15t tracks the script by it across renders.                                                                                                          |
+| `category`                                      | Required               | A category name, or a condition such as `{ or: ['measurement', 'marketing'] }`, `{ and: [...] }` or `{ not: '...' }`.                                                    |
+| `src` / `textContent`                           | None                   | Set exactly one, unless `callbackOnly` is `true` or returns `true`.                                                                                                      |
+| `vendor`                                        | None                   | Vendor slug, so a visitor can turn this vendor off inside an allowed category.                                                                                           |
+| `callbackOnly`                                  | `false`                | `true` or a zero-argument predicate returning `true` runs callbacks without adding a script element.                                                                     |
+| `alwaysLoad`                                    | `false`                | Load regardless of permission.                                                                                                                                           |
+| `persistAfterConsentRevoked`                    | `false`                | `true` keeps the element after withdrawal, including pending downloads. `'loaded'` keeps only elements whose load event completed; pending and failed loads are removed. |
+| `onBeforeLoad`, `onLoad`, `onError`             | None                   | Run before the element is added, after it loads, and if it fails.                                                                                                        |
+| `onConsentChange`                               | None                   | Runs when permissions change after the script has loaded, and when it is removed.                                                                                        |
+| `onDispose`                                     | None                   | Runs when this configuration is removed or its loader is disposed. Revocation alone does not call it.                                                                    |
+| `target`                                        | `'head'`               | `'head'` or `'body'`.                                                                                                                                                    |
+| `async`, `defer`, `attributes`, `fetchPriority` | None                   | Copied to the script element.                                                                                                                                            |
+| `nonce`                                         | The provider's `nonce` | Content Security Policy nonce for this element.                                                                                                                          |
+| `anonymizeId`                                   | `true`                 | Use a random element ID. Set `false` for `c15t-script-<id>`.                                                                                                             |
 
 Every callback receives `{ id, elementId, hasConsent, consents }`, plus
 `vendor` when the script declares one, and `element` for scripts with an
@@ -137,6 +137,19 @@ a callback-only script runs `onBeforeLoad` and `onLoad` only once permission is
 allowed. [PostHog](./posthog.md#use-an-existing-posthog-sdk) shows
 this pattern with a real SDK.
 
+For runtime detection, `callbackOnly` also accepts a zero-argument function
+that returns a boolean. c15t evaluates it before each new mount, when reading
+diagnostics, and when selecting scripts for server startup. Return `true` to
+use callbacks alone, or `false` to load `src` or `textContent`. Keep the function
+free of side effects and safe to call on the server. It can run more than once,
+and it does not remove an element already mounted by that registration.
+A function survives script customization with object spread, so later mounts
+check the current runtime instead of a value captured when the copy was made.
+Keep the function reference stable across script updates, for example by
+defining it at module level. A new function counts as a resource change and
+remounts the registration. If a predicate throws during server startup, c15t
+leaves that script to the client loader and starts unrelated scripts normally.
+
 ## Revocation and verification
 
 By default c15t reloads the page when a visitor turns off a category or vendor

package/docs/integrations/clearbit.md

@@ -249,7 +249,7 @@ A kernel you create yourself needs a loader from
 
 `clearbit` uses the `marketing` category, not `measurement`. Clearbit
 identifies visitors and their companies for enrichment, so c15t treats it as
-marketing even though these docs list it with analytics. The `tags.js` script
+marketing. The `tags.js` script
 loads with `referrerpolicy="strict-origin-when-cross-origin"` only while
 marketing is allowed. On revocation the helper removes the script element and
 calls no Clearbit API.

package/docs/integrations/customer-io.md

@@ -0,0 +1,369 @@
+---
+title: Customer.io
+description: Load Customer.io Data Pipelines only after marketing consent with
+  the c15t customerIo helper, set up a proxy, and check withdrawal.
+seoTitle: Customer.io cookie consent with c15t
+seoDescription: Load Customer.io only with marketing consent. Set your write
+  key, region and proxy, and reset identity on withdrawal with c15t.
+icon: chart-line
+group: integrations
+---
+
+Customer.io collects events and visitor identity on your site through its
+Data Pipelines JavaScript source, for use in its messaging. The c15t
+`customerIo` helper waits for `marketing` consent before it creates the
+`cioanalytics` global or downloads the SDK.
+
+When the visitor withdraws, the helper calls `cioanalytics.reset()` to clear
+the stored identity, and c15t reloads the page. `reset()` is not an opt-out.
+The reload is what stops the SDK.
+
+## Configure Customer.io
+
+Create a JavaScript source in Customer.io Data Pipelines and copy its write
+key. Note the region of your workspace. Then remove the original Customer.io
+snippet from your site, so that c15t controls when it loads.
+
+| Package manager | Command                          |
+| :-------------- | :------------------------------- |
+| npm             | `npm install @c15t/integrations` |
+| pnpm            | `pnpm add @c15t/integrations`    |
+| yarn            | `yarn add @c15t/integrations`    |
+| bun             | `bun add @c15t/integrations`     |
+
+```ts title="src/consent-scripts.ts"
+import { customerIo } from '@c15t/integrations/customer-io';
+
+export const scripts = [customerIo({ writeKey: 'YOUR_WRITE_KEY' })];
+```
+
+## 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 the vendor loads only through c15t.
+
+The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
+quickstart already has a `scripts` array, such as the one in `c15t.config.ts`
+in the Next.js guide, add the helper to that array instead of creating a
+second file.
+The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
+point for your framework below. These are edits to that provider, not a second
+provider.
+
+**Next.js**
+
+Add the configuration to `scripts` in `c15t.config.ts`, next to
+`next.config.ts`:
+
+```ts title="c15t.config.ts"
+import { defineConsentConfig } from 'c15t/next';
+import { scripts } from './src/consent-scripts';
+
+export default defineConsentConfig({ scripts });
+```
+
+Keep the rest of your config, such as `mode` and `routePrefix`, in the
+same call. `ConsentRoot` reads the config in the browser, so the layout
+keeps passing only `state`. App Router, Pages Router and static export all
+read the same file. See
+[Next.js scripts and embeds](https://c15t.com/docs/frameworks/next/scripts).
+
+**TanStack Start**
+
+Import the configuration into your root route and pass it to the existing
+`ConsentRoot` as a top-level prop. Keep the loader from the
+[TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart):
+
+```tsx title="src/routes/__root.tsx"
+import { scripts } from '../consent-scripts';
+
+<ConsentRoot state={consent} scripts={scripts}>
+```
+
+Import vendor helpers in the root route module, not in a server function.
+A server function's return value must be serializable, and script
+configurations carry callbacks. See
+[TanStack Start scripts](https://c15t.com/docs/frameworks/tanstack-start/scripts).
+
+**React**
+
+Add the configuration to the existing `ConsentProvider` options, next to
+`mode`:
+
+```tsx title="src/consent.tsx"
+import { scripts } from './consent-scripts';
+
+<ConsentProvider options={{ mode, scripts }}>
+```
+
+`mode` is the `manifest()` value from the
+[React quickstart](../frameworks/react/quickstart.md). Keep the banner,
+dialog and preferences link inside the provider. See
+[React scripts and embeds](../frameworks/react/scripts.md).
+
+**Nuxt**
+
+Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
+relative import to where you created `consent-scripts.ts`:
+
+```ts title="app/app.config.ts"
+import { scripts } from '../src/consent-scripts';
+
+export default defineAppConfig({
+  c15t: { scripts },
+});
+```
+
+The Nuxt module merges this over its options in `nuxt.config.ts` and starts
+one script loader in the browser after hydration, once it has applied the
+visitor's stored choice and privacy signals. Keep `scripts` out of
+`nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
+callbacks. Write the vendor IDs into `consent-scripts.ts`. See
+[Nuxt scripts and embeds](https://c15t.com/docs/frameworks/nuxt/scripts).
+
+**Vue**
+
+Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
+
+```ts title="src/main.ts"
+import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
+import { scripts } from './consent-scripts';
+
+app.use(c15tVue, {
+  mode: manifest(),
+  scripts,
+});
+```
+
+Keep your existing `mode` and other options. The plugin starts one
+script loader when the app mounts, after it has applied the visitor's stored
+choice. Do not also call `createScriptLoader` from a component. See
+[Vue scripts and embeds](https://c15t.com/docs/frameworks/vue/scripts).
+
+**Astro**
+
+Add the scripts to the client entrypoint from the
+[Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart), `src/c15t.client.ts`,
+which the integration finds on its own. Keep `astro.config.mjs` as it is.
+If the module already exports scripts, combine the two arrays.
+
+```ts title="src/c15t.client.ts"
+import type { C15tClientOptionsExtension } from 'c15t/astro';
+import { scripts } from './consent-scripts';
+
+export default { scripts } satisfies C15tClientOptionsExtension;
+```
+
+Vendor helpers contain callbacks, and the integration options in
+`astro.config.mjs` are serialized into the page, so do not put helpers in
+the integration's `scripts` option. The integration passes the client
+entrypoint to the one runtime every page shares, including across
+`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 { ConsentProvider, manifest } from 'c15t/svelte';
+  import { scripts } from './consent-scripts';
+</script>
+
+<ConsentProvider mode={manifest()} {scripts}>
+  <!-- Keep your application, consent UI and preferences link here. -->
+</ConsentProvider>
+```
+
+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 `ConsentRoot` in the root layout. Keep the
+handle and the layout load from the [SvelteKit quickstart](https://c15t.com/docs/frameworks/sveltekit/quickstart).
+
+```svelte title="src/routes/+layout.svelte"
+<script lang="ts">
+  import { ConsentRoot } from 'c15t/svelte';
+  import { scripts } from '../consent-scripts';
+
+  let { children, data } = $props();
+</script>
+
+<ConsentRoot state={data.consent} {scripts}>
+  {@render children()}
+  <!-- Keep your consent UI and preferences link here. -->
+</ConsentRoot>
+```
+
+Import vendor helpers in the layout component, not in `+layout.server.ts`:
+a server load cannot send functions to the browser. Prerendered, static and
+SPA-mode pages use the same `scripts` prop. If you pass an externally owned
+`runtime` to the provider, register scripts when creating that runtime instead.
+
+**HTML**
+
+The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
+page that loads the c15t script tag, paste the vendor's own snippet instead
+and keep it inert until its category is allowed:
+
+```html
+<script type="text/plain" data-c15t-category="measurement">
+  // The vendor's snippet, unchanged
+</script>
+```
+
+Use the category this guide names for the vendor. c15t runs the snippet
+once that category is allowed, and reloads the page when the visitor
+withdraws it. Helper options on this page, such as `loadMode`, do not apply
+to a pasted snippet. See [HTML scripts](https://c15t.com/docs/frameworks/html/scripts).
+
+**JavaScript**
+
+Pass the scripts to `init()` from `@c15t/browser`, next to your mode:
+
+```ts
+import { init, manifest } from '@c15t/browser';
+import { scripts } from './consent-scripts';
+
+const consent = init({
+  mode: manifest(),
+  scripts,
+});
+```
+
+Keep the mode from your quickstart. With
+`createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
+A kernel you create yourself needs a loader from
+`c15t/modules/script-loader`. Attach one loader per kernel. See
+[JavaScript scripts](https://c15t.com/docs/frameworks/javascript/scripts).
+
+## Options
+
+| Option        | Default                                                        | Behavior                                                                                                                                             |
+| ------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `writeKey`    | Required                                                       | Write key of your Data Pipelines JavaScript source. Whitespace is trimmed. If it's missing or blank, c15t logs an error and never loads Customer.io. |
+| `region`      | `us`                                                           | `us` uses `cdp.customer.io`. `eu` uses `cdp-eu.customer.io`. Any other value throws `customerIo: region must be 'us' or 'eu'`.                       |
+| `loadOptions` | Unset                                                          | Options for the Customer.io loader, such as destination settings. The helper always sets `initialPageview` to `false`, even if you pass `true`.      |
+| `category`    | `marketing`                                                    | Consent condition for the whole loader.                                                                                                              |
+| `cdnUrl`      | Region's HTTPS origin                                          | Origin for the loader, source settings and SDK files. See [Use a proxy](#use-a-proxy). Blank values use the regional default.                        |
+| `scriptUrl`   | `<cdnUrl>/v1/analytics-js/snippet/<writeKey>/analytics.min.js` | Overrides only the initial loader URL. Blank values use the default.                                                                                 |
+
+## Use a proxy
+
+Set `cdnUrl` to your proxy's HTTP(S) origin. The helper trims whitespace and
+trailing slashes. Any path, query, fragment or credentials, or a value without
+a scheme, throws `customerIo: cdnUrl must be an HTTP(S) origin`. `cdnUrl` sets
+`cioanalytics._cdn` as well as the default loader URL, so source settings and
+SDK files come from your proxy too. The proxy must keep Customer.io's paths and
+forward to the source's regional host. A `scriptUrl` override alone doesn't
+change where the SDK loads its files from.
+
+`cdnUrl` doesn't move collected events. To proxy Data Pipelines events, set
+`apiHost` for the `Customer.io Data Pipelines` integration in `loadOptions` to
+your collection proxy host plus `/v1`, without a scheme, and set `protocol` to
+`https`:
+
+```ts title="src/customer-io-proxy.ts"
+import { customerIo } from '@c15t/integrations/customer-io';
+
+export const proxiedScripts = [
+	customerIo({
+		cdnUrl: 'https://analytics.example.com',
+		loadOptions: {
+			integrations: {
+				'Customer.io Data Pipelines': {
+					apiHost: 'collect.example.com/v1',
+					protocol: 'https',
+				},
+			},
+		},
+		writeKey: 'YOUR_WRITE_KEY',
+	}),
+];
+```
+
+Replace both example domains with your own proxies. Neither option redirects
+traffic that destinations send themselves. Configure each destination
+separately where it supports a proxy.
+
+## Loading and revocation
+
+After consent, the helper creates Customer.io's array queue and method stubs,
+sets `_writeKey`, `_cdn` and `_loadOptions`, and loads the SDK. The script
+element carries the namespace attribute Customer.io requires. If the page
+already has a loaded `cioanalytics`, the helper keeps it.
+
+The helper sends the first `page()` call itself, once the SDK has loaded and
+consent is still granted, and again on each new grant after that. That's why
+it forces `initialPageview` to `false`. It copies `loadOptions`, so your object
+stays unchanged. It doesn't wait for `ready()`, because a destination can fail
+to initialize and some destinations need `page()` before they can start. A
+revoked or disposed loader doesn't send a pending first page view.
+
+While the SDK downloads, each method stub returns the same `cioanalytics`
+queue. Calls such as `cioanalytics.identify('customer-123').track('Signed up')`
+queue both calls in order. `cioanalytics` is undefined before consent, so
+check marketing consent before your own code calls it.
+
+On withdrawal, the helper calls `reset()` to clear identity. That doesn't stop
+the SDK, its retries or destination SDKs from sending, so keep
+`reloadOnConsentRevoked` enabled. The SDK loads once per page. A new grant on
+the same page reuses it instead of adding another copy. On the next page,
+while marketing is denied, the helper creates no queue and makes no vendor
+requests.
+
+## Cookies and storage
+
+Customer.io can use analytics identity cookies and `localStorage` keys
+including `ack`, `reclaimStart`, `reclaimEnd`, `inProgress` and `queue`.
+Destinations can add storage of their own. `reset()` doesn't erase all
+destination data.
+
+## Verify Customer.io
+
+Filter the Network panel by `customer.io`, or by your proxy's domain. Before
+consent, and after you allow an unrelated category, check that there is no
+snippet request, no `cioanalytics` global and no vendor cookies or browser
+storage. Allow marketing and check that the SDK initialized. Withdraw marketing
+and confirm the page reloads and the next page stays quiet. A 200 JSON response
+for an invalid write key doesn't prove the SDK initialized.
+
+With a proxy, check that the snippet, `/v1/projects/<writeKey>/settings` and
+the SDK files come from the CDN proxy. Check event collection separately
+against the `apiHost` you set. A successful load doesn't prove that events
+reach your workspace or destinations.
+
+Sources: Customer.io's [JavaScript source](https://docs.customer.io/cdp/sources/connections/javascript/js-source/),
+[in-app snippet](https://docs.customer.io/integrations/data-in/connections/javascript/in-app/),
+[proxy setup](https://docs.customer.io/integrations/data-in/connections/javascript/js-source-proxy/)
+and [utility methods](https://docs.customer.io/integrations/data-in/connections/javascript/utility-methods/).
+
+Test in a private window with an opt-in policy. Open DevTools Network, disable
+the cache and filter by the vendor's domain:
+
+1. Load the page. No request goes to the vendor before you choose.
+2. Click Reject, then reload. There is still no vendor request.
+3. Open Privacy settings and allow the helper's category. The vendor script
+   loads without a page reload.
+4. Turn the category off again and save. c15t reloads the page, and the new
+   page makes no vendor request.
+
+c15t reloads on revocation because removing a script element does not stop
+code that already ran. The vendor's listeners, timers and queued events stay
+alive until the page unloads. If you set `reloadOnConsentRevoked: false`, stop
+the vendor yourself. Register a callback-only script whose `onConsentChange`
+calls the vendor's opt-out API, as shown in
+[custom integrations](./building-integrations.md), and check the
+permission before each of your own event calls. The reload does not delete
+cookies the vendor already set; see
+[clear on revocation for your framework](./overview.md#vendor-switches-and-cookie-cleanup).
+
+The helper lists its vendor by name in the preference dialog, so a visitor can
+turn it off inside an allowed category. See
+[vendor consent for your framework](./overview.md#vendor-switches-and-cookie-cleanup). The
+[consent verification guide](../guides/verify-consent.md) covers navigation,
+expiry and hosting checks.