@c15t/scripts 2.0.0 → 2.1.0

package/dist-types/__tests__/helpers.d.ts

@@ -0,0 +1,141 @@
+import type { ConsentState, Script, ScriptCallbackInfo } from 'c15t';
+import { type BuiltInScriptIntegrationKey } from '../registry';
+/**
+ * Typed view of `globalThis` used by script helper tests.
+ *
+ * Additional string-keyed properties model browser and vendor globals created
+ * during setup and individual test cases.
+ */
+export type TestGlobal = typeof globalThis & Record<string, unknown>;
+/**
+ * Snapshot of the script fields asserted by helper tests.
+ */
+export interface HelperScriptSnapshot {
+    /** Unique script identifier generated by the helper under test. */
+    id: string;
+    /** Consent category associated with the script integration. */
+    category: unknown;
+    /** Whether the script should load even before optional consent is granted. */
+    alwaysLoad?: boolean;
+    /** Whether the script stays loaded after consent for its category is revoked. */
+    persistAfterConsentRevoked?: boolean;
+    /** Remote script URL emitted by the helper, when applicable. */
+    src?: string;
+}
+/**
+ * Expected integration metadata and script attributes for a helper assertion.
+ */
+export interface ExpectedScriptSnapshot {
+    /** Expected `alwaysLoad` flag from the generated helper script. */
+    alwaysLoad: boolean | undefined;
+    /** Expected consent-revocation persistence flag from the generated script. */
+    persistAfterConsentRevoked: boolean | undefined;
+    /** Expected remote script URL from the generated helper script. */
+    src: string;
+}
+/**
+ * Consent state with only required storage enabled.
+ *
+ * `necessary` keeps essential storage on, `functionality` covers site
+ * preferences, `measurement` controls analytics, `marketing` controls
+ * advertising-related storage, and `experience` controls personalization.
+ */
+export declare const deniedConsentState: ConsentState;
+/**
+ * Consent state with required and measurement storage enabled.
+ *
+ * `necessary` keeps essential storage on, `functionality` covers site
+ * preferences, `measurement` controls analytics, `marketing` controls
+ * advertising-related storage, and `experience` controls personalization.
+ */
+export declare const grantedMeasurementConsentState: ConsentState;
+/**
+ * Required callback fields for creating a script lifecycle payload in tests.
+ */
+export type CallbackInfoOverrides = Partial<ScriptCallbackInfo> & Pick<ScriptCallbackInfo, 'id'>;
+/**
+ * Creates a fully typed callback payload for script lifecycle tests.
+ *
+ * Defaults model a denied-consent callback for the same DOM element ID as the
+ * script ID, while allowing individual tests to override the relevant fields.
+ */
+export declare function createCallbackInfo(overrides: CallbackInfoOverrides): ScriptCallbackInfo;
+export type LifecycleCallbackOverrides = Partial<Omit<ScriptCallbackInfo, 'id'>>;
+export declare function runOnBeforeLoad(script: Pick<Script, 'id' | 'onBeforeLoad'>, overrides?: LifecycleCallbackOverrides): void;
+/**
+ * Returns a mutable test-friendly reference to the global object.
+ *
+ * @returns The current global object cast to `TestGlobal`.
+ *
+ * @example
+ * ```ts
+ * const globalRef = getTestGlobal();
+ * globalRef.dataLayer = [];
+ * ```
+ */
+export declare function getTestGlobal(): TestGlobal;
+/**
+ * Registers browser-like setup and teardown hooks for script helper tests.
+ *
+ * Before each test, this installs mocked `window` and `document` globals.
+ * After each test, it unstubs globals and removes vendor-specific globals left
+ * behind by script execution.
+ *
+ * @returns Nothing.
+ *
+ * @example
+ * ```ts
+ * describe('googleTagManager', () => {
+ * 	setupScriptHelperTest();
+ * });
+ * ```
+ */
+export declare function setupScriptHelperTest(): void;
+/**
+ * Asserts that a helper-generated script matches registry metadata and
+ * expected script fields.
+ *
+ * @param key - Built-in integration key used to find the registry entry.
+ * @param script - Snapshot of the helper-generated script under test.
+ * @param expected - Expected script metadata and output for the assertion.
+ * @returns Nothing.
+ *
+ * @remarks
+ * If `key` does not match any built-in integration, the assertion fails before
+ * the non-null access is used.
+ *
+ * @example
+ * ```ts
+ * expectScriptMatchesIntegration(
+ * 	'googleTagManager',
+ * 	googleTagManager({ id: 'GTM-123' }),
+ * 	{
+ * 		alwaysLoad: true,
+ * 		persistAfterConsentRevoked: undefined,
+ * 		src: 'https://www.googletagmanager.com/gtm.js?id=GTM-123',
+ * 	}
+ * );
+ * ```
+ */
+export declare function expectScriptMatchesIntegration(key: BuiltInScriptIntegrationKey, script: HelperScriptSnapshot, expected: ExpectedScriptSnapshot): void;
+/**
+ * Converts an array-like value into a plain array.
+ *
+ * @param value - Array-like input such as `arguments`, a `NodeList`, or a
+ * vendor queue entry.
+ * @returns A new array containing the indexed values from `value`.
+ *
+ * @remarks
+ * Passing `null` or `undefined` throws because `slice` requires an object-like
+ * value.
+ *
+ * @example
+ * ```ts
+ * function collectArgs(...args: unknown[]) {
+ * 	return toArgumentsArray(args);
+ * }
+ * ```
+ */
+export declare function toArgumentsArray(value: unknown): unknown[];
+export declare function expectGoogleConsentDefault(entry: unknown): void;
+export declare function expectStubCommandQueue(stub: unknown, queueKey: string, commands: unknown[][]): void;

package/dist-types/engine/runtime.d.ts

@@ -1,3 +1,3 @@
 import { type Script } from 'c15t';
-import type { ResolvedManifest } from '../types';
+import { type ResolvedManifest } from '../types';
 export declare function resolvedManifestToScript(resolvedManifest: ResolvedManifest): Script;

package/dist-types/registry.d.ts

@@ -0,0 +1,368 @@
+/**
+ * High-level product area for a built-in script integration.
+ *
+ * Used for discovery surfaces such as docs navigation and CLI grouping. This is
+ * intentionally separate from a manifest consent category.
+ */
+export type IntegrationCategory = 'analytics' | 'ads-and-pixels' | 'functional' | 'tag-manager';
+/**
+ * Consent bucket that a built-in integration maps to by default.
+ *
+ * These values mirror c15t's consent categories without importing core types, so
+ * the registry stays safe to consume from docs and CLI code.
+ */
+export type IntegrationConsentCategory = 'necessary' | 'functionality' | 'experience' | 'measurement' | 'marketing';
+/**
+ * Display metadata for an integration category.
+ *
+ * @example
+ * ```ts
+ * const label = BUILT_IN_INTEGRATION_CATEGORIES[0]?.label;
+ * ```
+ */
+export interface IntegrationCategoryEntry {
+    /** Stable category key used by registry entries. */
+    key: IntegrationCategory;
+    /** Human-readable label for display surfaces. */
+    label: string;
+}
+/**
+ * Identity and discovery metadata for a built-in script integration.
+ *
+ * All fields are required except `hint`, which is optional short help text for
+ * picker UIs. Do not add runtime behavior, disclosure metadata, or vendor
+ * implementation details here.
+ */
+export interface IntegrationRegistryEntry {
+    /** Stable key used by tests and generated metadata. */
+    key: string;
+    /** Script id emitted by the resolved helper. */
+    vendor: string;
+    /** Human-readable integration name. */
+    label: string;
+    /** Optional short description for CLI or docs picker UIs. */
+    hint?: string;
+    /** Docs route slug for this integration. */
+    docsSlug: string;
+    /** Package subpath, e.g. `meta-pixel` for `@c15t/scripts/meta-pixel`. */
+    packageSubpath: string;
+    /** Product area used for grouping and discovery. */
+    integrationCategory: IntegrationCategory;
+    /** Default consent bucket expected from the generated script. */
+    consentCategory: IntegrationConsentCategory;
+}
+/**
+ * Canonical display list for built-in integration categories.
+ *
+ * Consumers should use this list for category labels and ordering instead of
+ * re-declaring category names.
+ */
+export declare const BUILT_IN_INTEGRATION_CATEGORIES: readonly [{
+    readonly key: "analytics";
+    readonly label: "Analytics";
+}, {
+    readonly key: "ads-and-pixels";
+    readonly label: "Ads & Pixels";
+}, {
+    readonly key: "functional";
+    readonly label: "Functional";
+}, {
+    readonly key: "tag-manager";
+    readonly label: "Tag Managers";
+}];
+/**
+ * Canonical identity catalog for built-in `@c15t/scripts` integrations.
+ *
+ * Adding a new built-in integration should add one row here so docs, tests, and
+ * the CLI can discover it from the same source.
+ */
+export declare const builtInScriptIntegrations: readonly [{
+    readonly key: "googleTagManager";
+    readonly vendor: "google-tag-manager";
+    readonly label: "Google Tag Manager";
+    readonly hint: "GTM container script";
+    readonly docsSlug: "google-tag-manager";
+    readonly packageSubpath: "google-tag-manager";
+    readonly integrationCategory: "tag-manager";
+    readonly consentCategory: "necessary";
+}, {
+    readonly key: "gtag";
+    readonly vendor: "gtag";
+    readonly label: "Google Tag (gtag.js)";
+    readonly hint: "Google Analytics 4";
+    readonly docsSlug: "google-tag";
+    readonly packageSubpath: "google-tag";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "ahrefsAnalytics";
+    readonly vendor: "ahrefs-analytics";
+    readonly label: "Ahrefs Analytics";
+    readonly hint: "Cookieless web analytics from Ahrefs";
+    readonly docsSlug: "ahrefs-analytics";
+    readonly packageSubpath: "ahrefs-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "cloudflareWebAnalytics";
+    readonly vendor: "cloudflare-web-analytics";
+    readonly label: "Cloudflare Web Analytics";
+    readonly hint: "Cookieless analytics from Cloudflare";
+    readonly docsSlug: "cloudflare-web-analytics";
+    readonly packageSubpath: "cloudflare-web-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "microsoft-clarity";
+    readonly vendor: "microsoft-clarity";
+    readonly label: "Microsoft Clarity";
+    readonly hint: "Session replay and heatmaps";
+    readonly docsSlug: "microsoft-clarity";
+    readonly packageSubpath: "microsoft-clarity";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "databuddy";
+    readonly vendor: "databuddy";
+    readonly label: "Databuddy";
+    readonly hint: "Data collection";
+    readonly docsSlug: "databuddy";
+    readonly packageSubpath: "databuddy";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "fathomAnalytics";
+    readonly vendor: "fathom-analytics";
+    readonly label: "Fathom Analytics";
+    readonly hint: "Privacy-friendly cookieless analytics";
+    readonly docsSlug: "fathom-analytics";
+    readonly packageSubpath: "fathom-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "mixpanelAnalytics";
+    readonly vendor: "mixpanel-analytics";
+    readonly label: "Mixpanel Analytics";
+    readonly hint: "Product analytics and funnels";
+    readonly docsSlug: "mixpanel-analytics";
+    readonly packageSubpath: "mixpanel-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "hotjar";
+    readonly vendor: "hotjar";
+    readonly label: "Hotjar";
+    readonly hint: "Heatmaps and session recordings";
+    readonly docsSlug: "hotjar";
+    readonly packageSubpath: "hotjar";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "matomoAnalytics";
+    readonly vendor: "matomo-analytics";
+    readonly label: "Matomo Analytics";
+    readonly hint: "Self-hosted privacy analytics";
+    readonly docsSlug: "matomo-analytics";
+    readonly packageSubpath: "matomo-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "posthog";
+    readonly vendor: "posthog";
+    readonly label: "PostHog";
+    readonly hint: "Product analytics";
+    readonly docsSlug: "posthog";
+    readonly packageSubpath: "posthog";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "promptwatch";
+    readonly vendor: "promptwatch";
+    readonly label: "Promptwatch";
+    readonly hint: "AI traffic analytics";
+    readonly docsSlug: "promptwatch";
+    readonly packageSubpath: "promptwatch";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "segment";
+    readonly vendor: "segment";
+    readonly label: "Segment";
+    readonly hint: "Customer data platform";
+    readonly docsSlug: "segment";
+    readonly packageSubpath: "segment";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "rybbitAnalytics";
+    readonly vendor: "rybbit-analytics";
+    readonly label: "Rybbit Analytics";
+    readonly hint: "Privacy-friendly web analytics";
+    readonly docsSlug: "rybbit-analytics";
+    readonly packageSubpath: "rybbit-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "plausibleAnalytics";
+    readonly vendor: "plausible-analytics";
+    readonly label: "Plausible Analytics";
+    readonly hint: "Privacy-friendly cookieless analytics";
+    readonly docsSlug: "plausible-analytics";
+    readonly packageSubpath: "plausible-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "umamiAnalytics";
+    readonly vendor: "umami-analytics";
+    readonly label: "Umami Analytics";
+    readonly hint: "Open-source cookieless analytics";
+    readonly docsSlug: "umami-analytics";
+    readonly packageSubpath: "umami-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "vercelAnalytics";
+    readonly vendor: "vercel-analytics";
+    readonly label: "Vercel Analytics";
+    readonly hint: "Vercel web analytics";
+    readonly docsSlug: "vercel-analytics";
+    readonly packageSubpath: "vercel-analytics";
+    readonly integrationCategory: "analytics";
+    readonly consentCategory: "measurement";
+}, {
+    readonly key: "crisp";
+    readonly vendor: "crisp";
+    readonly label: "Crisp";
+    readonly hint: "Live chat widget";
+    readonly docsSlug: "crisp";
+    readonly packageSubpath: "crisp";
+    readonly integrationCategory: "functional";
+    readonly consentCategory: "functionality";
+}, {
+    readonly key: "intercom";
+    readonly vendor: "intercom";
+    readonly label: "Intercom";
+    readonly hint: "Messenger and live chat widget";
+    readonly docsSlug: "intercom";
+    readonly packageSubpath: "intercom";
+    readonly integrationCategory: "functional";
+    readonly consentCategory: "functionality";
+}, {
+    readonly key: "metaPixel";
+    readonly vendor: "meta-pixel";
+    readonly label: "Meta Pixel";
+    readonly hint: "Facebook/Instagram tracking";
+    readonly docsSlug: "meta-pixel";
+    readonly packageSubpath: "meta-pixel";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "redditPixel";
+    readonly vendor: "reddit-pixel";
+    readonly label: "Reddit Pixel";
+    readonly hint: "Reddit ads tracking";
+    readonly docsSlug: "reddit-pixel";
+    readonly packageSubpath: "reddit-pixel";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "tiktokPixel";
+    readonly vendor: "tiktok-pixel";
+    readonly label: "TikTok Pixel";
+    readonly hint: "TikTok ads tracking";
+    readonly docsSlug: "tiktok-pixel";
+    readonly packageSubpath: "tiktok-pixel";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "linkedinInsights";
+    readonly vendor: "linkedin-insights";
+    readonly label: "LinkedIn Insight Tag";
+    readonly hint: "LinkedIn conversion tracking";
+    readonly docsSlug: "linkedin-insights";
+    readonly packageSubpath: "linkedin-insights";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "microsoftUet";
+    readonly vendor: "microsoft-uet";
+    readonly label: "Microsoft UET";
+    readonly hint: "Bing Ads tracking";
+    readonly docsSlug: "microsoft-uet";
+    readonly packageSubpath: "microsoft-uet";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "snapchatPixel";
+    readonly vendor: "snapchat-pixel";
+    readonly label: "Snapchat Pixel";
+    readonly hint: "Snapchat ads tracking";
+    readonly docsSlug: "snapchat-pixel";
+    readonly packageSubpath: "snapchat-pixel";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}, {
+    readonly key: "xPixel";
+    readonly vendor: "x-pixel";
+    readonly label: "X (Twitter) Pixel";
+    readonly hint: "X/Twitter conversion tracking";
+    readonly docsSlug: "x-pixel";
+    readonly packageSubpath: "x-pixel";
+    readonly integrationCategory: "ads-and-pixels";
+    readonly consentCategory: "marketing";
+}];
+/**
+ * Concrete registry entry type inferred from `builtInScriptIntegrations`.
+ */
+export type BuiltInScriptIntegration = (typeof builtInScriptIntegrations)[number];
+/**
+ * Union of stable keys for built-in integrations.
+ */
+export type BuiltInScriptIntegrationKey = BuiltInScriptIntegration['key'];
+/**
+ * Union of public package subpaths for built-in integrations.
+ */
+export type BuiltInScriptIntegrationSubpath = BuiltInScriptIntegration['packageSubpath'];
+/**
+ * Looks up a built-in integration by its registry key.
+ *
+ * @param key - Stable integration key.
+ * @returns The matching built-in integration entry.
+ * @throws `Error("Unknown built-in script integration: <key>")` when the key is
+ * not present. Catch this when accepting untrusted or user-provided keys.
+ *
+ * @example
+ * ```ts
+ * const integration = getBuiltInScriptIntegration('metaPixel');
+ * console.log(integration.packageSubpath); // "meta-pixel"
+ * ```
+ */
+export declare function getBuiltInScriptIntegration(key: BuiltInScriptIntegrationKey): BuiltInScriptIntegration;
+/**
+ * Finds a built-in integration by its public package subpath.
+ *
+ * @param subpath - Kebab-case subpath such as `google-tag`.
+ * @returns The matching integration, or `undefined` when no entry matches.
+ *
+ * @example
+ * ```ts
+ * const integration = getBuiltInScriptIntegrationBySubpath('meta-pixel');
+ * console.log(integration?.label); // "Meta Pixel"
+ * ```
+ */
+export declare function getBuiltInScriptIntegrationBySubpath(subpath: string): BuiltInScriptIntegration | undefined;
+/**
+ * Finds a built-in integration by the emitted script vendor id.
+ *
+ * Use this to connect a resolved manifest/script id back to registry metadata.
+ *
+ * @param vendor - Vendor id emitted as `Script.id`.
+ * @returns The matching integration, or `undefined` when no entry matches.
+ *
+ * @example
+ * ```ts
+ * const integration = getBuiltInScriptIntegrationByVendor('google-tag-manager');
+ * console.log(integration?.label); // "Google Tag Manager"
+ * ```
+ */
+export declare function getBuiltInScriptIntegrationByVendor(vendor: string): BuiltInScriptIntegration | undefined;

package/dist-types/types.d.ts

@@ -5,6 +5,19 @@ export declare const vendorManifestContract: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
 };
+export declare const RUNTIME_VALUE_KIND = "c15t.runtime-value";
+export interface RuntimeValue {
+    kind: typeof RUNTIME_VALUE_KIND;
+    value: 'date' | 'timestamp';
+}
+export declare const runtimeDateValue: {
+    readonly kind: "c15t.runtime-value";
+    readonly value: "date";
+};
+export declare const runtimeTimestampValue: {
+    readonly kind: "c15t.runtime-value";
+    readonly value: "timestamp";
+};
 export interface ManifestContract {
     kind: typeof VENDOR_MANIFEST_KIND;
     schemaVersion: typeof VENDOR_MANIFEST_SCHEMA_VERSION;

package/dist-types/vendors/_shared/attributes.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Converts an optional boolean into a string suitable for a script `data-*`
+ * attribute.
+ *
+ * @param value - Optional boolean value from a vendor option.
+ * @returns `'true'` or `'false'` when a boolean is provided, otherwise
+ * `undefined` so the manifest compiler can omit the attribute.
+ *
+ * @example
+ * ```ts
+ * booleanDataAttribute(true); // 'true'
+ * booleanDataAttribute(false); // 'false'
+ * booleanDataAttribute(undefined); // undefined
+ * ```
+ */
+export declare function booleanDataAttribute(value: boolean | undefined): string | undefined;
+/**
+ * Converts a string or string list into a script `data-*` attribute value.
+ *
+ * Arrays are JSON-serialized so values containing commas can be round-tripped
+ * with `JSON.parse` by consumers that read the attribute.
+ *
+ * @param value - Optional string value or string list from a vendor option.
+ * @returns The original string, a JSON-serialized array, or `undefined` so the
+ * manifest compiler can omit the attribute.
+ *
+ * @example
+ * ```ts
+ * listDataAttribute('example.com'); // 'example.com'
+ * listDataAttribute(['a.com', 'b.com']); // '["a.com","b.com"]'
+ * listDataAttribute([]); // undefined
+ * listDataAttribute(undefined); // undefined
+ * ```
+ */
+export declare function listDataAttribute(value: string[] | string | undefined): string | undefined;

package/dist-types/vendors/_shared/google-consent.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Default c15t consent category mapping for Google Consent Mode v2.
+ *
+ * @remarks
+ * Shared by direct gtag.js and Google Tag Manager integrations so both emit the
+ * same Google storage consent defaults unless a caller provides an override.
+ *
+ * @example
+ * ```ts
+ * const manifest = {
+ * 	consentMapping: GOOGLE_CONSENT_MODE_V2_DEFAULT_MAPPING,
+ * };
+ * ```
+ */
+export declare const GOOGLE_CONSENT_MODE_V2_DEFAULT_MAPPING: Record<string, string[]>;
+/**
+ * Applies an optional Google consent mapping override to a manifest.
+ *
+ * @param manifest - Vendor manifest that already contains the default consent
+ * mapping.
+ * @param consentMapping - Optional caller-provided mapping from c15t consent
+ * categories to Google consent types.
+ * @returns The original manifest when no override is provided, or a shallow
+ * copy with the override mapping when one is provided.
+ *
+ * @example
+ * ```ts
+ * const customMapping: Record<string, string[]> = {
+ * 	marketing: ['ad_storage'],
+ * };
+ * const mapped = withOptionalConsentMapping<TManifest>(
+ * 	manifest,
+ * 	customMapping
+ * );
+ * ```
+ *
+ * @example
+ * ```ts
+ * const unchanged = withOptionalConsentMapping<TManifest>(
+ * 	manifest,
+ * 	undefined
+ * );
+ * ```
+ */
+export declare function withOptionalConsentMapping<TManifest extends {
+    consentMapping?: Record<string, string[]>;
+}>(manifest: TManifest, consentMapping: Record<string, string[]> | undefined): TManifest;

package/dist-types/vendors/_shared/install-builders.d.ts

@@ -0,0 +1,30 @@
+import type { VendorManifest } from '../../types';
+/**
+ * Optional tracking call inserted between the vendor init call and script load.
+ */
+interface QueuePixelInstallStep {
+    /** Arguments passed to the vendor queue function. */
+    args: unknown[];
+}
+/**
+ * Options for building the common pixel install sequence.
+ */
+export interface BuildQueuePixelInstallOptions {
+    /** Global queue function to call, for example `rdt` or `snaptr`. */
+    global: string;
+    /** Arguments for the required initialization call. */
+    initArgs: unknown[];
+    /** Optional tracking command queued immediately after initialization. */
+    trackStep?: QueuePixelInstallStep;
+    /** Manifest interpolation token used for the final loader script URL. */
+    scriptPlaceholder?: string;
+}
+/**
+ * Builds the common queue-pixel install sequence used by advertising pixels.
+ *
+ * @param options - Queue pixel install options.
+ * @returns Manifest install steps containing the required init call, an
+ * optional tracking call, and an async `loadScript` step.
+ */
+export declare function buildQueuePixelInstall({ global, initArgs, trackStep, scriptPlaceholder, }: BuildQueuePixelInstallOptions): VendorManifest['install'];
+export {};