@codefast/tracking 0.5.0-canary.4 → 1.0.0-canary.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +171 -0
- package/README.md +123 -96
- package/dist/client/browser-cookie.d.mts +11 -0
- package/dist/client/browser-cookie.mjs +15 -0
- package/dist/client/consent-runtime.d.mts +56 -0
- package/dist/client/consent-runtime.mjs +35 -0
- package/dist/client/consent-storage.d.mts +5 -0
- package/dist/client/consent-storage.mjs +20 -1
- package/dist/client/consent-withdrawal.d.mts +21 -0
- package/dist/client/consent-withdrawal.mjs +17 -0
- package/dist/client/cookie-anonymous-id.d.mts +37 -0
- package/dist/client/cookie-anonymous-id.mjs +46 -0
- package/dist/client/create-client-tracker.d.mts +11 -16
- package/dist/client/create-client-tracker.mjs +27 -53
- package/dist/client/gpc.d.mts +2 -0
- package/dist/client/gpc.mjs +3 -1
- package/dist/client/index.d.mts +7 -5
- package/dist/client/index.mjs +8 -6
- package/dist/client/initial-consent-store.d.mts +66 -0
- package/dist/client/initial-consent-store.mjs +119 -0
- package/dist/client/is-analytics-allowed.d.mts +29 -0
- package/dist/client/is-analytics-allowed.mjs +23 -0
- package/dist/client/server-persisted-anonymous-id.d.mts +33 -0
- package/dist/client/server-persisted-anonymous-id.mjs +50 -0
- package/dist/core/consent-config.d.mts +27 -0
- package/dist/core/consent-config.mjs +11 -0
- package/dist/core/consent.d.mts +99 -4
- package/dist/core/consent.mjs +99 -4
- package/dist/core/cookie.d.mts +17 -0
- package/dist/core/cookie.mjs +23 -0
- package/dist/core/destination.d.mts +10 -8
- package/dist/core/event-catalog.d.mts +16 -13
- package/dist/core/event-catalog.mjs +19 -1
- package/dist/core/event-id.d.mts +1 -2
- package/dist/core/event-id.mjs +1 -2
- package/dist/core/index.d.mts +6 -4
- package/dist/core/index.mjs +5 -3
- package/dist/core/tracked-event.d.mts +21 -8
- package/dist/destinations/google-analytics.d.mts +100 -48
- package/dist/destinations/google-analytics.mjs +89 -85
- package/dist/destinations/google-consent.d.mts +64 -0
- package/dist/destinations/google-consent.mjs +102 -0
- package/dist/destinations/index.d.mts +2 -5
- package/dist/destinations/index.mjs +2 -5
- package/dist/destinations/shared.d.mts +20 -0
- package/dist/destinations/shared.mjs +13 -0
- package/dist/destinations/vercel-analytics.d.mts +19 -4
- package/dist/destinations/vercel-analytics.mjs +11 -18
- package/dist/import-protection.d.mts +19 -0
- package/dist/import-protection.mjs +23 -0
- package/dist/index.d.mts +6 -4
- package/dist/index.mjs +5 -3
- package/dist/react/consent-banner.d.mts +143 -38
- package/dist/react/consent-banner.mjs +192 -92
- package/dist/react/gtag-consent-bootstrap.d.mts +27 -0
- package/dist/react/gtag-consent-bootstrap.mjs +29 -0
- package/dist/react/index.d.mts +5 -2
- package/dist/react/index.mjs +5 -2
- package/dist/react/use-consent.d.mts +9 -13
- package/dist/react/use-consent.mjs +42 -25
- package/dist/react/use-google-consent-sync.d.mts +23 -0
- package/dist/react/use-google-consent-sync.mjs +24 -0
- package/dist/react/use-initial-consent.d.mts +14 -0
- package/dist/react/use-initial-consent.mjs +19 -0
- package/dist/server/anonymous-id-cookie.d.mts +46 -0
- package/dist/server/anonymous-id-cookie.mjs +51 -0
- package/dist/server/index.d.mts +5 -3
- package/dist/server/index.mjs +4 -3
- package/dist/server/initial-consent.d.mts +29 -0
- package/dist/server/initial-consent.mjs +31 -0
- package/dist/server/region.d.mts +21 -4
- package/dist/server/region.mjs +26 -5
- package/dist/tanstack-start/index.d.mts +58 -0
- package/dist/tanstack-start/index.mjs +45 -0
- package/package.json +27 -110
- package/src/client/browser-cookie.ts +16 -0
- package/src/client/consent-runtime.ts +80 -0
- package/src/client/consent-storage.ts +31 -1
- package/src/client/consent-withdrawal.ts +32 -0
- package/src/client/cookie-anonymous-id.ts +93 -0
- package/src/client/create-client-tracker.ts +56 -85
- package/src/client/gpc.ts +4 -2
- package/src/client/index.ts +19 -8
- package/src/client/initial-consent-store.ts +218 -0
- package/src/client/is-analytics-allowed.ts +43 -0
- package/src/client/server-persisted-anonymous-id.ts +99 -0
- package/src/core/consent-config.ts +27 -0
- package/src/core/consent.ts +164 -10
- package/src/core/cookie.ts +29 -0
- package/src/core/destination.ts +10 -8
- package/src/core/event-catalog.ts +28 -15
- package/src/core/event-id.ts +1 -2
- package/src/core/index.ts +19 -3
- package/src/core/tracked-event.ts +22 -7
- package/src/css/consent.css +119 -0
- package/src/destinations/google-analytics.ts +196 -133
- package/src/destinations/google-consent.ts +164 -0
- package/src/destinations/index.ts +14 -15
- package/src/destinations/shared.ts +45 -0
- package/src/destinations/vercel-analytics.ts +23 -24
- package/src/import-protection.ts +20 -0
- package/src/index.ts +46 -8
- package/src/react/consent-banner.tsx +308 -111
- package/src/react/gtag-consent-bootstrap.tsx +48 -0
- package/src/react/index.ts +34 -2
- package/src/react/use-consent.ts +53 -45
- package/src/react/use-google-consent-sync.ts +38 -0
- package/src/react/use-initial-consent.ts +22 -0
- package/src/server/anonymous-id-cookie.ts +76 -0
- package/src/server/index.ts +15 -3
- package/src/server/initial-consent.ts +48 -0
- package/src/server/region.ts +22 -5
- package/src/tanstack-start/index.ts +83 -0
- package/dist/client/lifecycle.d.mts +0 -23
- package/dist/client/lifecycle.mjs +0 -30
- package/dist/client/local-storage.d.mts +0 -13
- package/dist/client/local-storage.mjs +0 -31
- package/dist/client/queue.d.mts +0 -49
- package/dist/client/queue.mjs +0 -71
- package/dist/client/router.d.mts +0 -30
- package/dist/client/router.mjs +0 -17
- package/dist/destinations/ga4-measurement-protocol.d.mts +0 -54
- package/dist/destinations/ga4-measurement-protocol.mjs +0 -89
- package/dist/destinations/http-destination.d.mts +0 -20
- package/dist/destinations/http-destination.mjs +0 -25
- package/dist/server/create-server-tracker.d.mts +0 -42
- package/dist/server/create-server-tracker.mjs +0 -67
- package/src/client/lifecycle.ts +0 -50
- package/src/client/local-storage.ts +0 -44
- package/src/client/queue.ts +0 -117
- package/src/client/router.ts +0 -37
- package/src/destinations/ga4-measurement-protocol.ts +0 -166
- package/src/destinations/http-destination.ts +0 -33
- package/src/server/create-server-tracker.ts +0 -128
|
@@ -1,13 +1,28 @@
|
|
|
1
1
|
import { Destination } from "../core/destination.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/destinations/vercel-analytics.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* @since 1.0.0-canary.6
|
|
6
|
+
*/
|
|
7
|
+
interface VercelAnalyticsDestinationOptions {
|
|
8
|
+
/**
|
|
9
|
+
* Vercel Analytics is cookieless and its events carry no identifier from this
|
|
10
|
+
* package, so it qualifies for `"exempt"` — it then keeps receiving events while the
|
|
11
|
+
* tracker's analytics gate is closed. Defaults to `"required"` so pre-consent delivery
|
|
12
|
+
* stays an explicit opt-in.
|
|
13
|
+
*/
|
|
14
|
+
consentRequirement?: "exempt" | "required" | undefined;
|
|
15
|
+
name?: string | undefined;
|
|
16
|
+
}
|
|
4
17
|
/**
|
|
5
18
|
* `track()` only pushes onto Vercel's own in-page queue (`window.va`/`window.vaq`), which
|
|
6
|
-
* handles batching and unload delivery itself
|
|
7
|
-
* `<Analytics />` from `@vercel/analytics/react
|
|
19
|
+
* handles batching and unload delivery itself. Requires the Vercel Analytics script to be
|
|
20
|
+
* loaded once elsewhere in the app (`<Analytics />` from `@vercel/analytics/react`, or the
|
|
21
|
+
* framework-agnostic `inject()`) — this destination only queues events, so it imports the
|
|
22
|
+
* base `@vercel/analytics` package and has no React dependency of its own.
|
|
8
23
|
*
|
|
9
24
|
* @since 0.5.0-canary.4
|
|
10
25
|
*/
|
|
11
|
-
declare function createVercelAnalyticsDestination(
|
|
26
|
+
declare function createVercelAnalyticsDestination(options?: VercelAnalyticsDestinationOptions): Destination;
|
|
12
27
|
//#endregion
|
|
13
|
-
export { createVercelAnalyticsDestination };
|
|
28
|
+
export { VercelAnalyticsDestinationOptions, createVercelAnalyticsDestination };
|
|
@@ -1,28 +1,21 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { flattenEventProps } from "./shared.mjs";
|
|
2
|
+
import { track } from "@vercel/analytics";
|
|
2
3
|
//#region src/destinations/vercel-analytics.ts
|
|
3
4
|
/**
|
|
4
|
-
* Vercel's `track()` rejects nested objects/arrays outright — flatten anything else
|
|
5
|
-
* to a string instead of silently dropping it.
|
|
6
|
-
*/
|
|
7
|
-
function toVercelAnalyticsProps(props) {
|
|
8
|
-
const result = {};
|
|
9
|
-
for (const [key, value] of Object.entries(props)) if (value === null || typeof value === "string" || typeof value === "number" || typeof value === "boolean") result[key] = value;
|
|
10
|
-
else if (value !== void 0) result[key] = JSON.stringify(value);
|
|
11
|
-
return result;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
5
|
* `track()` only pushes onto Vercel's own in-page queue (`window.va`/`window.vaq`), which
|
|
15
|
-
* handles batching and unload delivery itself
|
|
16
|
-
* `<Analytics />` from `@vercel/analytics/react
|
|
6
|
+
* handles batching and unload delivery itself. Requires the Vercel Analytics script to be
|
|
7
|
+
* loaded once elsewhere in the app (`<Analytics />` from `@vercel/analytics/react`, or the
|
|
8
|
+
* framework-agnostic `inject()`) — this destination only queues events, so it imports the
|
|
9
|
+
* base `@vercel/analytics` package and has no React dependency of its own.
|
|
17
10
|
*
|
|
18
11
|
* @since 0.5.0-canary.4
|
|
19
12
|
*/
|
|
20
|
-
function createVercelAnalyticsDestination(
|
|
13
|
+
function createVercelAnalyticsDestination(options = {}) {
|
|
21
14
|
return {
|
|
22
|
-
|
|
23
|
-
name,
|
|
24
|
-
send(event) {
|
|
25
|
-
track(event.name,
|
|
15
|
+
consentRequirement: options.consentRequirement ?? "required",
|
|
16
|
+
name: options.name ?? "vercel-analytics",
|
|
17
|
+
async send(event) {
|
|
18
|
+
track(event.name, flattenEventProps(event.properties, { allowNull: true }));
|
|
26
19
|
}
|
|
27
20
|
};
|
|
28
21
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
//#region src/import-protection.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Import specifiers (picomatch patterns) every client bundle must deny — spread into
|
|
4
|
+
* TanStack Start's `importProtection.client.specifiers` so the deny-list ships and
|
|
5
|
+
* versions with the package instead of going stale in each consumer's config. Nothing in
|
|
6
|
+
* this package imports it — its consumers are app build configs (see apps/ui vite.config.ts).
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* tanstackStart({
|
|
11
|
+
* importProtection: { client: { specifiers: [...SERVER_ONLY_IMPORT_SPECIFIERS] } },
|
|
12
|
+
* });
|
|
13
|
+
* ```
|
|
14
|
+
*
|
|
15
|
+
* @since 1.0.0-canary.6
|
|
16
|
+
*/
|
|
17
|
+
declare const SERVER_ONLY_IMPORT_SPECIFIERS: ReadonlyArray<string>;
|
|
18
|
+
//#endregion
|
|
19
|
+
export { SERVER_ONLY_IMPORT_SPECIFIERS };
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
//#region src/import-protection.ts
|
|
2
|
+
/**
|
|
3
|
+
* Import specifiers (picomatch patterns) every client bundle must deny — spread into
|
|
4
|
+
* TanStack Start's `importProtection.client.specifiers` so the deny-list ships and
|
|
5
|
+
* versions with the package instead of going stale in each consumer's config. Nothing in
|
|
6
|
+
* this package imports it — its consumers are app build configs (see apps/ui vite.config.ts).
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* tanstackStart({
|
|
11
|
+
* importProtection: { client: { specifiers: [...SERVER_ONLY_IMPORT_SPECIFIERS] } },
|
|
12
|
+
* });
|
|
13
|
+
* ```
|
|
14
|
+
*
|
|
15
|
+
* @since 1.0.0-canary.6
|
|
16
|
+
*/
|
|
17
|
+
const SERVER_ONLY_IMPORT_SPECIFIERS = [
|
|
18
|
+
"@codefast/tracking/server",
|
|
19
|
+
"@codefast/tracking/server/**",
|
|
20
|
+
"@codefast/tracking/tanstack-start"
|
|
21
|
+
];
|
|
22
|
+
//#endregion
|
|
23
|
+
export { SERVER_ONLY_IMPORT_SPECIFIERS };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import { CONSENT_CATEGORIES, ConsentCategory, ConsentDecision, ConsentMode, ConsentRecord, ConsentRegion, ConsentStorage, createConsentDecision, isConsentDecision, resolveConsentMode, resolveDefaultConsent } from "./core/consent.mjs";
|
|
2
|
-
import {
|
|
1
|
+
import { CONSENT_CATEGORIES, CONSENT_REGIONS, ConsentCategory, ConsentDecision, ConsentMode, ConsentRecord, ConsentRegion, ConsentStorage, InitialConsent, ResolveDefaultConsentOptions, ResolveEffectiveConsentOptions, STRICTEST_INITIAL_CONSENT, createConsentDecision, isConsentDecision, isConsentRecord, isConsentRegion, isInitialConsent, normalizeConsentDecision, readStoredDecision, resolveConsentMode, resolveDefaultConsent, resolveEffectiveConsent } from "./core/consent.mjs";
|
|
2
|
+
import { ConsentConfig, defineConsentConfig } from "./core/consent-config.mjs";
|
|
3
|
+
import { TrackEvent, TrackedEvent, TrackedEventBase } from "./core/tracked-event.mjs";
|
|
3
4
|
import { Destination } from "./core/destination.mjs";
|
|
4
|
-
import { EventCatalog, EventDefinition,
|
|
5
|
+
import { EventCatalog, EventDefinition, assertValidEventProperties, defineEventCatalog } from "./core/event-catalog.mjs";
|
|
6
|
+
import { readCookieValue } from "./core/cookie.mjs";
|
|
5
7
|
import { generateEventId } from "./core/event-id.mjs";
|
|
6
|
-
export { CONSENT_CATEGORIES, type ConsentCategory, type ConsentDecision, type ConsentMode, type ConsentRecord, type ConsentRegion, type ConsentStorage, type Destination, type EventCatalog, type EventDefinition, type
|
|
8
|
+
export { CONSENT_CATEGORIES, CONSENT_REGIONS, type ConsentCategory, type ConsentConfig, type ConsentDecision, type ConsentMode, type ConsentRecord, type ConsentRegion, type ConsentStorage, type Destination, type EventCatalog, type EventDefinition, type InitialConsent, type ResolveDefaultConsentOptions, type ResolveEffectiveConsentOptions, STRICTEST_INITIAL_CONSENT, type TrackEvent, type TrackedEvent, type TrackedEventBase, assertValidEventProperties, createConsentDecision, defineConsentConfig, defineEventCatalog, generateEventId, isConsentDecision, isConsentRecord, isConsentRegion, isInitialConsent, normalizeConsentDecision, readCookieValue, readStoredDecision, resolveConsentMode, resolveDefaultConsent, resolveEffectiveConsent };
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import { CONSENT_CATEGORIES, createConsentDecision, isConsentDecision, resolveConsentMode, resolveDefaultConsent } from "./core/consent.mjs";
|
|
2
|
-
import {
|
|
1
|
+
import { CONSENT_CATEGORIES, CONSENT_REGIONS, STRICTEST_INITIAL_CONSENT, createConsentDecision, isConsentDecision, isConsentRecord, isConsentRegion, isInitialConsent, normalizeConsentDecision, readStoredDecision, resolveConsentMode, resolveDefaultConsent, resolveEffectiveConsent } from "./core/consent.mjs";
|
|
2
|
+
import { defineConsentConfig } from "./core/consent-config.mjs";
|
|
3
|
+
import { readCookieValue } from "./core/cookie.mjs";
|
|
4
|
+
import { assertValidEventProperties, defineEventCatalog } from "./core/event-catalog.mjs";
|
|
3
5
|
import { generateEventId } from "./core/event-id.mjs";
|
|
4
|
-
export { CONSENT_CATEGORIES, createConsentDecision, defineEventCatalog, generateEventId, isConsentDecision, resolveConsentMode, resolveDefaultConsent };
|
|
6
|
+
export { CONSENT_CATEGORIES, CONSENT_REGIONS, STRICTEST_INITIAL_CONSENT, assertValidEventProperties, createConsentDecision, defineConsentConfig, defineEventCatalog, generateEventId, isConsentDecision, isConsentRecord, isConsentRegion, isInitialConsent, normalizeConsentDecision, readCookieValue, readStoredDecision, resolveConsentMode, resolveDefaultConsent, resolveEffectiveConsent };
|
|
@@ -4,64 +4,168 @@ import { ComponentProps, ReactNode } from "react";
|
|
|
4
4
|
|
|
5
5
|
//#region src/react/consent-banner.d.ts
|
|
6
6
|
/**
|
|
7
|
-
* One row of the preferences layer — the visitor-facing wording for a consent category.
|
|
8
|
-
*
|
|
9
7
|
* @since 0.5.0-canary.4
|
|
10
8
|
*/
|
|
11
|
-
interface
|
|
12
|
-
category: ConsentCategory;
|
|
13
|
-
description?: string;
|
|
14
|
-
label: string;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @since 0.5.0-canary.4
|
|
18
|
-
*/
|
|
19
|
-
interface ConsentBannerProps extends Omit<ComponentProps<"section">, "children"> {
|
|
20
|
-
acceptLabel?: string;
|
|
21
|
-
/** Enables the per-category preferences layer; omit to keep the two-button banner. */
|
|
22
|
-
categories?: ReadonlyArray<ConsentCategoryOption>;
|
|
9
|
+
interface ConsentBannerProps extends ComponentProps<"section"> {
|
|
23
10
|
consent: UseConsentResult;
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
message?: ReactNode;
|
|
27
|
-
rejectLabel?: string;
|
|
28
|
-
saveLabel?: string;
|
|
11
|
+
/** Overrides the default `isPromptNeeded` gating — e.g. to reopen the banner as a settings panel. */
|
|
12
|
+
open?: boolean | undefined;
|
|
29
13
|
}
|
|
30
14
|
/**
|
|
31
|
-
* Non-blocking opt-in prompt for GDPR/
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* region, not a `<dialog>`: an open non-modal dialog
|
|
37
|
-
* page, so the dialog semantics would over-promise.
|
|
38
|
-
*
|
|
39
|
-
*
|
|
15
|
+
* Non-blocking opt-in prompt for GDPR/PDPL (VN) regions, as composable parts — the root owns
|
|
16
|
+
* the visibility gating and the preferences-layer state; the `Accept`/`Reject`/`Customize`/
|
|
17
|
+
* `Save` parts wire their own clicks to the consent hook, so any markup (including a
|
|
18
|
+
* design system's button styles via `className`) slots in. Renders nothing once a decision
|
|
19
|
+
* exists or the region defaults to opt-out (`consent.isPromptNeeded`), unless `open` says
|
|
20
|
+
* otherwise. Rendered as a labeled region, not a `<dialog>`: an open non-modal dialog
|
|
21
|
+
* neither traps focus nor blocks the page, so the dialog semantics would over-promise.
|
|
22
|
+
* Unstyled by default — style via `className`/`data-slot` selectors, or import the
|
|
23
|
+
* optional `@codefast/tracking/css/consent.css` theme. `data-state` on the root flips
|
|
24
|
+
* between `prompt` and `preferences` for state-dependent styling.
|
|
40
25
|
*
|
|
41
26
|
* @since 0.5.0-canary.4
|
|
42
27
|
*/
|
|
43
28
|
declare function ConsentBanner({
|
|
44
|
-
|
|
45
|
-
categories,
|
|
29
|
+
children,
|
|
46
30
|
consent,
|
|
47
|
-
|
|
48
|
-
message,
|
|
49
|
-
rejectLabel,
|
|
50
|
-
saveLabel,
|
|
31
|
+
open,
|
|
51
32
|
...props
|
|
52
33
|
}: ConsentBannerProps): ReactNode;
|
|
34
|
+
/**
|
|
35
|
+
* @since 0.5.0-canary.5
|
|
36
|
+
*/
|
|
37
|
+
interface ConsentBannerTitleProps extends ComponentProps<"h2"> {}
|
|
38
|
+
/**
|
|
39
|
+
* @since 0.5.0-canary.5
|
|
40
|
+
*/
|
|
41
|
+
declare function ConsentBannerTitle({
|
|
42
|
+
children,
|
|
43
|
+
...props
|
|
44
|
+
}: ConsentBannerTitleProps): ReactNode;
|
|
45
|
+
/**
|
|
46
|
+
* @since 0.5.0-canary.5
|
|
47
|
+
*/
|
|
48
|
+
interface ConsentBannerDescriptionProps extends ComponentProps<"p"> {}
|
|
49
|
+
/**
|
|
50
|
+
* Hosts the message and the privacy-policy link informed consent requires.
|
|
51
|
+
*
|
|
52
|
+
* @since 0.5.0-canary.5
|
|
53
|
+
*/
|
|
54
|
+
declare function ConsentBannerDescription(props: ConsentBannerDescriptionProps): ReactNode;
|
|
55
|
+
/**
|
|
56
|
+
* @since 0.5.0-canary.5
|
|
57
|
+
*/
|
|
58
|
+
interface ConsentBannerActionsProps extends ComponentProps<"div"> {}
|
|
59
|
+
/**
|
|
60
|
+
* @since 0.5.0-canary.5
|
|
61
|
+
*/
|
|
62
|
+
declare function ConsentBannerActions(props: ConsentBannerActionsProps): ReactNode;
|
|
63
|
+
/**
|
|
64
|
+
* @since 0.5.0-canary.5
|
|
65
|
+
*/
|
|
66
|
+
interface ConsentBannerAcceptProps extends Omit<ComponentProps<"button">, "type"> {}
|
|
67
|
+
/**
|
|
68
|
+
* Grants the categories the app requested (`useConsent`'s `requestedCategories`) — never more.
|
|
69
|
+
*
|
|
70
|
+
* @since 0.5.0-canary.5
|
|
71
|
+
*/
|
|
72
|
+
declare function ConsentBannerAccept({
|
|
73
|
+
onClick,
|
|
74
|
+
...props
|
|
75
|
+
}: ConsentBannerAcceptProps): ReactNode;
|
|
76
|
+
/**
|
|
77
|
+
* @since 0.5.0-canary.5
|
|
78
|
+
*/
|
|
79
|
+
interface ConsentBannerRejectProps extends Omit<ComponentProps<"button">, "type"> {}
|
|
80
|
+
/**
|
|
81
|
+
* @since 0.5.0-canary.5
|
|
82
|
+
*/
|
|
83
|
+
declare function ConsentBannerReject({
|
|
84
|
+
onClick,
|
|
85
|
+
...props
|
|
86
|
+
}: ConsentBannerRejectProps): ReactNode;
|
|
87
|
+
/**
|
|
88
|
+
* @since 0.5.0-canary.5
|
|
89
|
+
*/
|
|
90
|
+
interface ConsentBannerCustomizeProps extends Omit<ComponentProps<"button">, "type"> {}
|
|
91
|
+
/**
|
|
92
|
+
* Opens the per-category preferences layer, starting from the current effective state so
|
|
93
|
+
* nothing arrives pre-ticked in an opt-in region (pre-ticked consent is invalid under
|
|
94
|
+
* GDPR). Hidden while the layer is open — `ConsentBannerSave` takes over.
|
|
95
|
+
*
|
|
96
|
+
* @since 0.5.0-canary.5
|
|
97
|
+
*/
|
|
98
|
+
declare function ConsentBannerCustomize({
|
|
99
|
+
onClick,
|
|
100
|
+
...props
|
|
101
|
+
}: ConsentBannerCustomizeProps): ReactNode;
|
|
102
|
+
/**
|
|
103
|
+
* @since 0.5.0-canary.5
|
|
104
|
+
*/
|
|
105
|
+
interface ConsentBannerPreferencesProps extends ComponentProps<"div"> {}
|
|
106
|
+
/**
|
|
107
|
+
* Container for the per-category rows — renders only while the preferences layer is open.
|
|
108
|
+
*
|
|
109
|
+
* @since 0.5.0-canary.5
|
|
110
|
+
*/
|
|
111
|
+
declare function ConsentBannerPreferences(props: ConsentBannerPreferencesProps): ReactNode;
|
|
112
|
+
/**
|
|
113
|
+
* @since 0.5.0-canary.5
|
|
114
|
+
*/
|
|
115
|
+
interface ConsentBannerCategoryProps extends ComponentProps<"label"> {
|
|
116
|
+
category: ConsentCategory;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* One checkbox row of the preferences layer — `children` is the visitor-facing wording.
|
|
120
|
+
*
|
|
121
|
+
* @since 0.5.0-canary.5
|
|
122
|
+
*/
|
|
123
|
+
declare function ConsentBannerCategory({
|
|
124
|
+
category,
|
|
125
|
+
children,
|
|
126
|
+
...props
|
|
127
|
+
}: ConsentBannerCategoryProps): ReactNode;
|
|
128
|
+
/**
|
|
129
|
+
* @since 0.5.0-canary.5
|
|
130
|
+
*/
|
|
131
|
+
interface ConsentBannerSaveProps extends Omit<ComponentProps<"button">, "type"> {}
|
|
132
|
+
/**
|
|
133
|
+
* Persists the pending per-category selection — renders only while the preferences layer is open.
|
|
134
|
+
*
|
|
135
|
+
* @since 0.5.0-canary.5
|
|
136
|
+
*/
|
|
137
|
+
declare function ConsentBannerSave({
|
|
138
|
+
onClick,
|
|
139
|
+
...props
|
|
140
|
+
}: ConsentBannerSaveProps): ReactNode;
|
|
53
141
|
/**
|
|
54
142
|
* @since 0.5.0-canary.4
|
|
55
143
|
*/
|
|
56
144
|
interface ConsentToggleProps extends Omit<ComponentProps<"button">, "children" | "onClick" | "type"> {
|
|
57
|
-
|
|
145
|
+
/**
|
|
146
|
+
* Label shown while the scoped categories are denied — clicking grants them. Defaults
|
|
147
|
+
* to "Allow tracking".
|
|
148
|
+
*/
|
|
149
|
+
allowLabel?: string | undefined;
|
|
58
150
|
consent: UseConsentResult;
|
|
59
|
-
|
|
151
|
+
/**
|
|
152
|
+
* Label shown while any scoped category is granted — clicking denies them. Defaults to
|
|
153
|
+
* CCPA/CPRA "Do Not Sell or Share My Personal Information".
|
|
154
|
+
*/
|
|
155
|
+
denyLabel?: string | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* Purposes this control flips. Defaults to `["ads"]` — CCPA/CPRA "Do Not Sell or Share"
|
|
158
|
+
* mirrors GPC (ads denied, first-party analytics left alone). Pass `["analytics"]` (or
|
|
159
|
+
* both) for a broader opt-out. Distinct from `useConsent`'s `requestedCategories` (what the
|
|
160
|
+
* prompt asks about / `grantAll` grants).
|
|
161
|
+
*/
|
|
162
|
+
toggledCategories?: ReadonlyArray<ConsentCategory> | undefined;
|
|
60
163
|
}
|
|
61
164
|
/**
|
|
62
165
|
* Always-visible control for opt-out regions — CCPA/CPRA requires a persistent
|
|
63
166
|
* "Do Not Sell or Share My Personal Information" mechanism, not just a one-time prompt.
|
|
64
|
-
*
|
|
167
|
+
* By default it only flips `ads` (same scope as a GPC signal); pass `toggledCategories`
|
|
168
|
+
* to include analytics or both.
|
|
65
169
|
*
|
|
66
170
|
* @since 0.5.0-canary.4
|
|
67
171
|
*/
|
|
@@ -69,7 +173,8 @@ declare function ConsentToggle({
|
|
|
69
173
|
allowLabel,
|
|
70
174
|
consent,
|
|
71
175
|
denyLabel,
|
|
176
|
+
toggledCategories,
|
|
72
177
|
...props
|
|
73
178
|
}: ConsentToggleProps): ReactNode;
|
|
74
179
|
//#endregion
|
|
75
|
-
export { ConsentBanner, ConsentBannerProps,
|
|
180
|
+
export { ConsentBanner, ConsentBannerAccept, ConsentBannerAcceptProps, ConsentBannerActions, ConsentBannerActionsProps, ConsentBannerCategory, ConsentBannerCategoryProps, ConsentBannerCustomize, ConsentBannerCustomizeProps, ConsentBannerDescription, ConsentBannerDescriptionProps, ConsentBannerPreferences, ConsentBannerPreferencesProps, ConsentBannerProps, ConsentBannerReject, ConsentBannerRejectProps, ConsentBannerSave, ConsentBannerSaveProps, ConsentBannerTitle, ConsentBannerTitleProps, ConsentToggle, ConsentToggleProps };
|