@c15t/scripts 1.0.2-rc.0 → 1.1.0-rc.1

package/dist-types/google-tag.d.ts

@@ -1,10 +1,56 @@
-import type { AllConsentNames, Script } from '../../core/dist-types/index.d.ts';
+import type { AllConsentNames, Script } from 'c15t';
 declare global {
     interface Window {
         dataLayer: unknown[];
         gtag: (...args: unknown[]) => void;
     }
 }
+/**
+ * Google Tag (gtag.js) vendor manifest.
+ *
+ * Similar to GTM but for direct Google product integration (Analytics, Ads, Floodlight).
+ * Uses the same Consent Mode v2 mapping.
+ */
+export declare const gtagManifest: {
+    readonly vendor: "gtag";
+    readonly category: "{{category}}";
+    readonly alwaysLoad: true;
+    readonly persistAfterConsentRevoked: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "dataLayer";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineQueueFunction";
+        readonly name: "gtag";
+        readonly queue: "dataLayer";
+        readonly ifUndefined: true;
+    }];
+    readonly install: [{
+        readonly type: "callGlobal";
+        readonly global: "gtag";
+        readonly args: ["js", "{{loadTime}}"];
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "gtag";
+        readonly args: ["config", "{{id}}"];
+    }, {
+        readonly type: "loadScript";
+        readonly src: "https://www.googletagmanager.com/gtag/js?id={{id}}";
+        readonly async: true;
+    }];
+    readonly consentMapping: {
+        readonly necessary: ["security_storage"];
+        readonly functionality: ["functionality_storage"];
+        readonly measurement: ["analytics_storage"];
+        readonly marketing: ["ad_storage", "ad_user_data", "ad_personalization"];
+        readonly experience: ["personalization_storage"];
+    };
+    readonly consentSignal: "gtag";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface GtagOptions {
     /**
      * Your gtag id
@@ -17,15 +63,28 @@ export interface GtagOptions {
      */
     category: AllConsentNames;
     /**
-     * Override or extend the default script values.
+     * Custom mapping from c15t consent categories to Google Consent Mode v2 types.
+     * Overrides the default mapping when provided.
+     *
+     * @default
+     * ```ts
+     * {
+     *   necessary: ['security_storage'],
+     *   functionality: ['functionality_storage'],
+     *   measurement: ['analytics_storage'],
+     *   marketing: ['ad_storage', 'ad_user_data', 'ad_personalization'],
+     *   experience: ['personalization_storage'],
+     * }
+     * ```
+     */
+    consentMapping?: Record<string, string[]>;
+    /**
+     * Deprecated script-level overrides preserved for backwards compatibility.
      *
-     * Default values:
-     * - `id`: 'gtag'
-     * - `src`: `https://www.googletagmanager.com/gtag/js?id=${id}`
-     * - `async`: true
-     * - `alwaysLoad`: true
+     * Prefer manifest-backed options instead of this generic override bag.
+     * @deprecated
      */
-    script?: Partial<Omit<Script, 'category'>>;
+    script?: Partial<Script>;
 }
 /**
  * Creates a Google Tag (gtag.js) script.
@@ -34,4 +93,4 @@ export interface GtagOptions {
  * @param options - The options for the gtag script.
  * @returns The Google Tag Manager script.
  */
-export declare function gtag({ id, script, category }: GtagOptions): Script;
+export declare function gtag({ id, category, consentMapping, script, }: GtagOptions): Script;

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

@@ -0,0 +1 @@
+export {};

package/dist-types/linkedin-insights.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 declare global {
     interface Window {
         lintrk: ((...args: unknown[]) => void) & {
@@ -13,21 +13,53 @@ declare global {
         };
     }
 }
+/**
+ * LinkedIn Insights vendor manifest.
+ *
+ * Sets up the LinkedIn partner ID globals and loads the insights script
+ * via structured startup steps.
+ */
+export declare const linkedinInsightsManifest: {
+    readonly vendor: "linkedin-insights";
+    readonly category: "marketing";
+    readonly install: [{
+        readonly type: "setGlobal";
+        readonly name: "_linkedin_partner_id";
+        readonly value: "{{id}}";
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "setGlobal";
+        readonly name: "_linkedin_data_partner_ids";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "pushToQueue";
+        readonly queue: "_linkedin_data_partner_ids";
+        readonly value: "{{id}}";
+    }, {
+        readonly type: "defineStubFunction";
+        readonly name: "lintrk";
+        readonly queue: {
+            readonly property: "q";
+        };
+        readonly queueFormat: "array";
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface LinkedInInsightsOptions {
     /**
      * Your LinkedIn Insights ID
      * @example `123456789012345`
      */
     id: string;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'linkedin-insights'
-     * - `src`: `https://snap.licdn.com/li.lms-analytics/insight.min.js`
-     * - `category`: 'marketing'
-     */
-    script?: Partial<Script>;
+    /** LinkedIn Insights loader URL. */
+    scriptSrc?: string;
 }
 /**
  * LinkedIn Insights Script
@@ -44,4 +76,4 @@ export interface LinkedInInsightsOptions {
  *
  * @see {@link https://business.linkedin.com/marketing-solutions/ad-libraries/insights} LinkedIn Insights documentation
  */
-export declare function linkedinInsights({ id, script, }: LinkedInInsightsOptions): Script;
+export declare function linkedinInsights({ id, scriptSrc, }: LinkedInInsightsOptions): Script;

package/dist-types/meta-pixel.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 /**
  * Represents the `contents` array object property.
  */
@@ -83,27 +83,75 @@ declare global {
         _fbq: Window['fbq'];
     }
 }
+/**
+ * Meta Pixel vendor manifest.
+ *
+ * The Meta Pixel uses structured bootstrap steps to define the standard `fbq`
+ * stub and provides a consent API via `fbq('consent', 'grant'|'revoke')`.
+ */
+export declare const metaPixelManifest: {
+    readonly vendor: "meta-pixel";
+    readonly category: "marketing";
+    readonly persistAfterConsentRevoked: true;
+    readonly bootstrap: [{
+        readonly type: "defineStubFunction";
+        readonly name: "fbq";
+        readonly queue: {
+            readonly property: "queue";
+        };
+        readonly dispatchProperty: "callMethod";
+        readonly selfReferences: ["push"];
+        readonly aliases: ["_fbq"];
+        readonly properties: {
+            readonly loaded: true;
+            readonly version: "2.0";
+        };
+        readonly ifUndefined: true;
+    }];
+    readonly install: [{
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["consent", "grant"];
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["init", "{{pixelId}}"];
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["track", "PageView"];
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["consent", "grant"];
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["consent", "revoke"];
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface MetaPixelOptions {
     /**
      * Your Meta Pixel ID
      * @example `123456789012345`
      */
     pixelId: string;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'meta-pixel'
-     * - `src`: `https://connect.facebook.net/en_US/fbevents.js`
-     * - `category`: 'marketing'
-     */
-    script?: Partial<Script>;
+    /** Meta Pixel loader URL. */
+    scriptSrc?: string;
 }
 /**
- * Creates a Meta Pixel script with inline JavaScript code.
+ * Creates a Meta Pixel script.
  *
- * This script uses textContent to inject the Meta Pixel tracking code directly
- * into the page, which is the recommended approach for Meta Pixel implementation.
+ * The manifest defines a structured `fbq` stub plus the external loader URL,
+ * avoiding raw inline vendor snippets in the manifest payload.
  *
  * @param options - The options for the Meta Pixel script
  * @returns The Meta Pixel script configuration
@@ -117,7 +165,7 @@ export interface MetaPixelOptions {
  *
  * @see {@link https://developers.facebook.com/docs/meta-pixel/get-started} Meta Pixel documentation
  */
-export declare function metaPixel({ pixelId, script }: MetaPixelOptions): Script;
+export declare function metaPixel({ pixelId, scriptSrc }: MetaPixelOptions): Script;
 /**
  * Meta Pixel Event
  * This is a wrapper around the `fbq` function that the Meta Pixel script uses.

package/dist-types/microsoft-uet.d.ts

@@ -1,24 +1,79 @@
-import type { Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 declare global {
     interface Window {
         uetq: unknown[] | undefined;
     }
 }
+/**
+ * Microsoft UET vendor manifest.
+ *
+ * Uses structured startup steps and manages consent via the UET push API:
+ * `window.uetq.push('consent', 'default'|'update', { ad_storage: 'granted'|'denied' })`
+ */
+export declare const microsoftUetManifest: {
+    readonly vendor: "microsoft-uet";
+    readonly category: "marketing";
+    readonly persistAfterConsentRevoked: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "uetq";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }];
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly afterLoad: [{
+        readonly type: "constructGlobal";
+        readonly constructor: "UET";
+        readonly assignTo: "uetq";
+        readonly args: [{
+            readonly ti: "{{id}}";
+            readonly enableAutoSpaTracking: true;
+        }];
+        readonly copyAssignedValueToArgProperty: "q";
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["pageLoad"];
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["consent", "default", {
+            readonly ad_storage: "granted";
+        }];
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["consent", "update", {
+            readonly ad_storage: "granted";
+        }];
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["consent", "update", {
+            readonly ad_storage: "denied";
+        }];
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface MicrosoftUetOptions {
     /**
      * Your Microsoft UET ID
      * @example `123456789012345`
      */
     id: string;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'microsoft-uet'
-     * - `src`: `//bat.bing.com/bat.js`
-     * - `category`: 'marketing'
-     */
-    script?: Partial<Script>;
+    /** Microsoft UET loader URL. */
+    scriptSrc?: string;
 }
 /**
  * Microsoft UET Script
@@ -36,4 +91,4 @@ export interface MicrosoftUetOptions {
  *
  * @see https://learn.microsoft.com/en-us/advertising/guides/universal-event-tracking?view=bingads-13
  */
-export declare function microsoftUet({ id, script }: MicrosoftUetOptions): Script;
+export declare function microsoftUet({ id, scriptSrc }: MicrosoftUetOptions): Script;

package/dist-types/posthog.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 declare global {
     interface Window {
         posthog: {
@@ -14,6 +14,78 @@ declare global {
         };
     }
 }
+/**
+ * PostHog vendor manifest.
+ *
+ * PostHog manages its own consent internally via opt_in/opt_out capturing.
+ * The script always loads, and consent is toggled via the PostHog API.
+ */
+export declare const posthogManifest: {
+    readonly vendor: "posthog";
+    readonly category: "measurement";
+    readonly alwaysLoad: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "posthog";
+        readonly value: {};
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineGlobalMethods";
+        readonly target: "posthog";
+        readonly methods: [{
+            readonly name: "init";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "opt_in_capturing";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "opt_out_capturing";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "get_explicit_consent_status";
+            readonly behavior: "return";
+            readonly value: "pending";
+        }];
+    }];
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly async: true;
+        readonly attributes: {
+            readonly crossorigin: "anonymous";
+            readonly 'data-api-host': "{{apiHost}}";
+            readonly 'data-ui-host': "{{apiHost}}";
+        };
+    }];
+    readonly afterLoad: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "init";
+        readonly args: ["{{id}}", "{{initOptions}}"];
+    }];
+    readonly onLoadGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_in_capturing";
+    }];
+    readonly onLoadDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_out_capturing";
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_in_capturing";
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_out_capturing";
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface PosthogConsentOptions {
     /**
      * Your posthog id, begins with 'phc_'.
@@ -23,24 +95,11 @@ export interface PosthogConsentOptions {
      * Your posthog api host.
      * @default 'https://eu.i.posthog.com'
      */
-    apiHost: string;
-    /**
-     * The defaults for the posthog script.
-     */
-    defaults: string;
-    /**
-     * Other optional options for the posthog script.
-     * @example { person_profiles: 'identified_only' }
-     */
-    options: Record<string, unknown>;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'posthog-consent'
-     * - `category`: 'measurement'
-     */
-    script?: Partial<Script>;
+    apiHost?: string;
+    /** The PostHog array loader URL. */
+    scriptUrl?: string;
+    /** PostHog init options passed to `posthog.init(...)`. */
+    initOptions?: Record<string, unknown>;
 }
 /**
  * Loads the PostHog script and initializes it with the given options.

package/dist-types/resolve.d.ts

@@ -0,0 +1,9 @@
+import type { Script } from 'c15t';
+import type { VendorManifest } from './types';
+/**
+ * Compiles a `VendorManifest` + config into a `Script` object.
+ *
+ * This compatibility wrapper preserves the existing public resolver API while
+ * delegating to the new compile and runtime conversion phases internally.
+ */
+export declare function resolveManifest(manifest: VendorManifest, config?: Record<string, unknown>): Script;

package/dist-types/tiktok-pixel.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 declare global {
     interface Window {
         ttq: {
@@ -8,21 +8,69 @@ declare global {
         };
     }
 }
+/**
+ * TikTok Pixel vendor manifest.
+ *
+ * Uses structured bootstrap steps and provides a consent API
+ * via `ttq.grantConsent()` / `ttq.revokeConsent()`.
+ */
+export declare const tiktokPixelManifest: {
+    readonly vendor: "tiktok-pixel";
+    readonly category: "marketing";
+    readonly persistAfterConsentRevoked: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "TiktokAnalyticsObject";
+        readonly value: "ttq";
+    }, {
+        readonly type: "setGlobal";
+        readonly name: "ttq";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineQueueMethods";
+        readonly target: "ttq";
+        readonly methods: ["page", "track", "identify", "instances", "debug", "on", "off", "once", "ready", "alias", "group", "enableCookie", "disableCookie", "holdConsent", "revokeConsent", "grantConsent"];
+    }];
+    readonly install: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "grantConsent";
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "page";
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq";
+        readonly async: true;
+    }];
+    readonly afterLoad: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "grantConsent";
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "grantConsent";
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "revokeConsent";
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface TikTokPixelOptions {
     /**
      * Your TikTok Pixel ID
      * @example `123456789012345`
      */
     pixelId: string;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'tiktok-pixel'
-     * - `src`: `https://analytics.tiktok.com/i18n/pixel/events.js`
-     * - `category`: 'marketing'
-     */
-    script?: Partial<Script>;
+    /** TikTok Pixel loader base URL. */
+    scriptSrc?: string;
 }
 /**
  * Creates a Tiktok Pixel script.
@@ -40,4 +88,4 @@ export interface TikTokPixelOptions {
  *
  * @see {@link https://ads.tiktok.com/help/article/tiktok-pixel} TikTok Pixel documentation
  */
-export declare function tiktokPixel({ pixelId, script }: TikTokPixelOptions): Script;
+export declare function tiktokPixel({ pixelId, scriptSrc, }: TikTokPixelOptions): Script;