@c15t/react 3.1.0 → 3.2.0

package/docs/integrations/vector.md

@@ -0,0 +1,333 @@
+---
+title: Vector
+description: Load the Vector pixel only after marketing consent with the c15t
+  vector helper, and check its queue, storage and revocation.
+seoTitle: Vector consent with c15t
+seoDescription: Load Vector's pixel only after marketing consent with c15t, and
+  check its loader, storage and page reload on withdrawal.
+icon: radar
+group: integrations
+---
+
+Vector identifies the people and companies visiting your site and builds
+advertising audiences from their activity. The c15t `vector` helper keeps
+Vector off the page until the `marketing` category is allowed. Vector has no
+documented stop API, so on withdrawal c15t reloads the page to stop it.
+
+## Configure Vector
+
+Copy the pixel ID from **Settings > Pixel** in your Vector account, where the
+install snippet calls `vector.load`. Vector's own consent example requires
+advertising consent, so this helper uses the `marketing` category. Remove the
+direct snippet and any tag manager copy so they can't bypass c15t.
+
+| 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 { vector } from '@c15t/integrations/vector';
+
+export const scripts = [vector({ pixelId: 'YOUR_PIXEL_ID' })];
+```
+
+## 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                                                                                                                                      |
+| ----------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `pixelId`   | Required                         | Pixel ID from your account snippet. Whitespace is trimmed. A missing or blank ID logs `vector: missing or invalid pixelId` and skips loading. |
+| `scriptUrl` | `https://cdn.vector.co/pixel.js` | Custom SDK URL. Blank values use the default.                                                                                                 |
+
+## Loading and revocation
+
+After consent, the helper creates `window.vector` with a queue for `load`,
+`identify` and `on`. Calls use Vector's nested argument format,
+`[methodName, argsArray]`, and preserve callback references. The helper queues
+`load(pixelId)` before inserting the asynchronous SDK script. Existing SDK
+methods are preserved. The helper sends no identification calls itself.
+
+The loader stays registered across withdrawal and regrant to avoid duplicate
+execution on the same page. Vector has no documented complete shutdown API.
+Keep c15t's default page reload on revocation enabled. With reload disabled,
+running code, pending loads and partner activity can continue until navigation.
+The reload doesn't clear Vector's storage.
+
+The helper does not call the undocumented `block` or `removeVisitor` methods.
+Form listening and IP-to-company lookup depend on account settings. Vector's
+IP-to-company consent hooks cover only that lookup and cannot replace gating
+the whole pixel.
+
+## Requests, cookies and storage
+
+Vector's CSP guide lists `cdn.vector.co`, `api.vector.co` and
+`a.usbrowserspeed.com`. The current SDK also includes LiveIntent and can contact
+`idx.liadm.com`. Check requests for your account before setting CSP rules.
+
+The current SDK prefers local storage, with session storage, cookies and memory
+as fallbacks. Pixel state can include
+`vector_pixel_<pixelId>_visitor_id`, `vector_pixel_<pixelId>_visitor_uuid`,
+`vector_pixel_<pixelId>_synced_at` and
+`vector_pixel_<pixelId>_last_identified_id`. Legacy and global keys also exist.
+
+The `vector_visitor_id` cookie depends on the account's `pixelCookieFallback`
+setting. The fetched SDK requests a lifetime of 3,650 days, with
+`SameSite=None; Secure`; browsers may shorten that lifetime. Partner state can
+include `_lc2_fpi`, `_lc2_fpi_js`, `_li_dcdm_c` and local-storage `_li_duid`.
+Vector can read the existing `hubspotutk` cookie. This list describes the fetched
+SDK, not a stable or exhaustive storage contract.
+
+## Verify Vector
+
+Use your own pixel ID on a domain allowed by your Vector account. In a fresh
+browser profile, deny optional consent, then grant only measurement consent.
+Confirm that no Vector global, SDK request or vendor storage appears. Grant
+marketing consent and confirm that `pixel.js` loads once. Withdraw consent and
+confirm the page reloads and blocks Vector on the new page. Check Network,
+cookies, local storage and session storage.
+
+c15t's live vendor probe uses a placeholder pixel ID. It confirms that the
+downloaded SDK replaces the queue, replays the nested calls and registers the
+pixel. It blocks settings, identity and collection requests, so the SDK can log
+a JSON error for the empty settings response. Vector checks the requesting
+domain before it returns settings, so the probe can't verify account settings
+or visitor identification. Test those with your own pixel ID on an allowed
+domain.
+
+Sources: [installing the Vector pixel](https://learn.vector.co/articles/5402074849-adding-the-pixel-to-your-site),
+[Vector's Termly consent example](https://learn.vector.co/articles/6201229721-installing-the-pixel-via-termly-s-consent-management-platform),
+[CSP settings](https://learn.vector.co/articles/1236044955-csp-settings),
+[Vector's privacy policy](https://www.vector.co/legal/privacy), and the
+[current pixel SDK](https://cdn.vector.co/pixel.js).
+
+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.

package/docs/integrations/vercel-analytics.md

@@ -165,7 +165,7 @@ pass them as a top-level prop:
 
 ```svelte title="src/App.svelte"
 <script lang="ts">
-  import { ConsentProvider, manifest } from '@c15t/svelte';
+  import { ConsentProvider, manifest } from 'c15t/svelte';
   import { scripts } from './consent-scripts';
 </script>
 
@@ -184,7 +184,7 @@ handle and the layout load from the [SvelteKit quickstart](https://c15t.com/docs
 
 ```svelte title="src/routes/+layout.svelte"
 <script lang="ts">
-  import { ConsentRoot } from '@c15t/svelte';
+  import { ConsentRoot } from 'c15t/svelte';
   import { scripts } from '../consent-scripts';
 
   let { children, data } = $props();

package/docs/integrations/vercel-speed-insights.md

@@ -169,7 +169,7 @@ pass them as a top-level prop:
 
 ```svelte title="src/App.svelte"
 <script lang="ts">
-  import { ConsentProvider, manifest } from '@c15t/svelte';
+  import { ConsentProvider, manifest } from 'c15t/svelte';
   import { scripts } from './consent-scripts';
 </script>
 
@@ -188,7 +188,7 @@ handle and the layout load from the [SvelteKit quickstart](https://c15t.com/docs
 
 ```svelte title="src/routes/+layout.svelte"
 <script lang="ts">
-  import { ConsentRoot } from '@c15t/svelte';
+  import { ConsentRoot } from 'c15t/svelte';
   import { scripts } from '../consent-scripts';
 
   let { children, data } = $props();
@@ -276,6 +276,11 @@ The collector holds one `beforeSend` callback. Pass yours through the
 `beforeSend` option. Calling `window.si('beforeSend', ...)` yourself replaces
 the helper's consent check.
 
+A framework that starts allowed scripts from the server HTML starts the
+collector before the app hydrates, and the helper registers its callback at
+hydration. With a `beforeSend` option, the collector waits for hydration
+instead, so your callback sees every report.
+
 Reports only cover page loads after consent. The collector reads buffered
 paint and navigation timings, but interactions before consent are missed. The
 helper does not set `data-route`, so Vercel groups reports by URL rather than