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

package/dist/tiktok-pixel.js

@@ -1,30 +1,89 @@
-function tiktokPixel({ pixelId, script }) {
-    return {
-        id: script?.id ?? 'tiktok-pixel',
-        category: script?.category ?? 'marketing',
-        textContent: `
-!function (w, d, t) {
-  w.TiktokAnalyticsObject=t;var ttq=w[t]=w[t]||[];ttq.methods=["page","track","identify","instances","debug","on","off","once","ready","alias","group","enableCookie","disableCookie","holdConsent","revokeConsent","grantConsent"],ttq.setAndDefer=function(t,e){t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}};for(var i=0;i<ttq.methods.length;i++)ttq.setAndDefer(ttq,ttq.methods[i]);ttq.instance=function(t){for(
-var e=ttq._i[t]||[],n=0;n<ttq.methods.length;n++)ttq.setAndDefer(e,ttq.methods[n]);return e},ttq.load=function(e,n){var r="${script?.src ?? 'https://analytics.tiktok.com/i18n/pixel/events.js'}",o=n&&n.partner;ttq._i=ttq._i||{},ttq._i[e]=[],ttq._i[e]._u=r,ttq._t=ttq._t||{},ttq._t[e]=+new Date,ttq._o=ttq._o||{},ttq._o[e]=n||{};n=document.createElement("script")
-;n.type="text/javascript",n.async=!0,n.src=r+"?sdkid="+e+"&lib="+t;e=document.getElementsByTagName("script")[0];e.parentNode.insertBefore(n,e)};
-  ttq.load('${pixelId}');
-  ttq.grantConsent(); 
-  ttq.page();
-}(window, document, 'ttq');
-		`.trim(),
-        persistAfterConsentRevoked: true,
-        onLoad: (rest)=>{
-            window.ttq.grantConsent();
-            if (script?.onLoad) script.onLoad(rest);
+import { resolveManifest } from "./resolve.js";
+import { vendorManifestContract } from "./types.js";
+const tiktokPixelManifest = {
+    ...vendorManifestContract,
+    vendor: 'tiktok-pixel',
+    category: 'marketing',
+    persistAfterConsentRevoked: true,
+    bootstrap: [
+        {
+            type: 'setGlobal',
+            name: 'TiktokAnalyticsObject',
+            value: 'ttq'
         },
-        onConsentChange: ({ consents, ...rest })=>{
-            if (consents.marketing) window.ttq.grantConsent();
-            else window.ttq.revokeConsent();
-            if (script?.onConsentChange) script.onConsentChange({
-                consents,
-                ...rest
-            });
+        {
+            type: 'setGlobal',
+            name: 'ttq',
+            value: [],
+            ifUndefined: true
+        },
+        {
+            type: 'defineQueueMethods',
+            target: 'ttq',
+            methods: [
+                'page',
+                'track',
+                'identify',
+                'instances',
+                'debug',
+                'on',
+                'off',
+                'once',
+                'ready',
+                'alias',
+                'group',
+                'enableCookie',
+                'disableCookie',
+                'holdConsent',
+                'revokeConsent',
+                'grantConsent'
+            ]
+        }
+    ],
+    install: [
+        {
+            type: 'callGlobal',
+            global: 'ttq',
+            method: 'grantConsent'
+        },
+        {
+            type: 'callGlobal',
+            global: 'ttq',
+            method: 'page'
+        },
+        {
+            type: 'loadScript',
+            src: "{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq",
+            async: true
+        }
+    ],
+    afterLoad: [
+        {
+            type: 'callGlobal',
+            global: 'ttq',
+            method: 'grantConsent'
+        }
+    ],
+    onConsentGranted: [
+        {
+            type: 'callGlobal',
+            global: 'ttq',
+            method: 'grantConsent'
+        }
+    ],
+    onConsentDenied: [
+        {
+            type: 'callGlobal',
+            global: 'ttq',
+            method: 'revokeConsent'
         }
-    };
+    ]
+};
+function tiktokPixel({ pixelId, scriptSrc }) {
+    const resolved = resolveManifest(tiktokPixelManifest, {
+        pixelId,
+        scriptSrc: scriptSrc ?? 'https://analytics.tiktok.com/i18n/pixel/events.js'
+    });
+    return resolved;
 }
-export { tiktokPixel };
+export { tiktokPixel, tiktokPixelManifest };

package/dist/types.cjs

@@ -0,0 +1,47 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    VENDOR_MANIFEST_KIND: ()=>VENDOR_MANIFEST_KIND,
+    VENDOR_MANIFEST_SCHEMA_VERSION: ()=>VENDOR_MANIFEST_SCHEMA_VERSION,
+    vendorManifestContract: ()=>vendorManifestContract
+});
+const VENDOR_MANIFEST_KIND = 'c15t.vendor-manifest';
+const VENDOR_MANIFEST_SCHEMA_VERSION = 1;
+const vendorManifestContract = {
+    kind: VENDOR_MANIFEST_KIND,
+    schemaVersion: VENDOR_MANIFEST_SCHEMA_VERSION
+};
+exports.VENDOR_MANIFEST_KIND = __webpack_exports__.VENDOR_MANIFEST_KIND;
+exports.VENDOR_MANIFEST_SCHEMA_VERSION = __webpack_exports__.VENDOR_MANIFEST_SCHEMA_VERSION;
+exports.vendorManifestContract = __webpack_exports__.vendorManifestContract;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "VENDOR_MANIFEST_KIND",
+    "VENDOR_MANIFEST_SCHEMA_VERSION",
+    "vendorManifestContract"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/types.js

@@ -0,0 +1,7 @@
+const VENDOR_MANIFEST_KIND = 'c15t.vendor-manifest';
+const VENDOR_MANIFEST_SCHEMA_VERSION = 1;
+const vendorManifestContract = {
+    kind: VENDOR_MANIFEST_KIND,
+    schemaVersion: VENDOR_MANIFEST_SCHEMA_VERSION
+};
+export { VENDOR_MANIFEST_KIND, VENDOR_MANIFEST_SCHEMA_VERSION, vendorManifestContract };

package/dist/x-pixel.cjs

@@ -13,7 +13,7 @@ var __webpack_require__ = {};
 })();
 (()=>{
     __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
             value: 'Module'
         });
         Object.defineProperty(exports1, '__esModule', {
@@ -25,26 +25,60 @@ var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     xPixel: ()=>xPixel,
-    xPixelEvent: ()=>xPixelEvent
+    xPixelEvent: ()=>xPixelEvent,
+    xPixelManifest: ()=>xPixelManifest
 });
-function xPixel({ pixelId, script }) {
-    return {
-        id: script?.id ?? 'x-pixel',
-        category: script?.category ?? 'marketing',
-        textContent: `
-!function(e,t,n,s,u,a){e.twq||(s=e.twq=function(){s.exe?s.exe.apply(s,arguments):s.queue.push(arguments);
-},s.version='1.1',s.queue=[],u=t.createElement(n),u.async=!0,u.src='${script?.src ?? 'https://static.ads-twitter.com/uwt.js'}',
-a=t.getElementsByTagName(n)[0],a.parentNode.insertBefore(u,a))}(window,document,'script');
-twq('config','${pixelId}');
-		`.trim()
-    };
+const external_resolve_cjs_namespaceObject = require("./resolve.cjs");
+const external_types_cjs_namespaceObject = require("./types.cjs");
+const xPixelManifest = {
+    ...external_types_cjs_namespaceObject.vendorManifestContract,
+    vendor: 'x-pixel',
+    category: 'marketing',
+    bootstrap: [
+        {
+            type: 'defineStubFunction',
+            name: 'twq',
+            queue: {
+                property: 'queue'
+            },
+            dispatchProperty: 'exe',
+            properties: {
+                version: '1.1'
+            },
+            ifUndefined: true
+        }
+    ],
+    install: [
+        {
+            type: 'callGlobal',
+            global: 'twq',
+            args: [
+                'config',
+                '{{pixelId}}'
+            ]
+        },
+        {
+            type: 'loadScript',
+            src: "{{scriptSrc}}",
+            async: true
+        }
+    ]
+};
+function xPixel({ pixelId, scriptSrc }) {
+    const resolved = (0, external_resolve_cjs_namespaceObject.resolveManifest)(xPixelManifest, {
+        pixelId,
+        scriptSrc: scriptSrc ?? 'https://static.ads-twitter.com/uwt.js'
+    });
+    return resolved;
 }
 const xPixelEvent = (eventId, metadata)=>window.twq?.('event', eventId, metadata);
 exports.xPixel = __webpack_exports__.xPixel;
 exports.xPixelEvent = __webpack_exports__.xPixelEvent;
+exports.xPixelManifest = __webpack_exports__.xPixelManifest;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
     "xPixel",
-    "xPixelEvent"
+    "xPixelEvent",
+    "xPixelManifest"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true

package/dist/x-pixel.js

@@ -1,14 +1,45 @@
-function xPixel({ pixelId, script }) {
-    return {
-        id: script?.id ?? 'x-pixel',
-        category: script?.category ?? 'marketing',
-        textContent: `
-!function(e,t,n,s,u,a){e.twq||(s=e.twq=function(){s.exe?s.exe.apply(s,arguments):s.queue.push(arguments);
-},s.version='1.1',s.queue=[],u=t.createElement(n),u.async=!0,u.src='${script?.src ?? 'https://static.ads-twitter.com/uwt.js'}',
-a=t.getElementsByTagName(n)[0],a.parentNode.insertBefore(u,a))}(window,document,'script');
-twq('config','${pixelId}');
-		`.trim()
-    };
+import { resolveManifest } from "./resolve.js";
+import { vendorManifestContract } from "./types.js";
+const xPixelManifest = {
+    ...vendorManifestContract,
+    vendor: 'x-pixel',
+    category: 'marketing',
+    bootstrap: [
+        {
+            type: 'defineStubFunction',
+            name: 'twq',
+            queue: {
+                property: 'queue'
+            },
+            dispatchProperty: 'exe',
+            properties: {
+                version: '1.1'
+            },
+            ifUndefined: true
+        }
+    ],
+    install: [
+        {
+            type: 'callGlobal',
+            global: 'twq',
+            args: [
+                'config',
+                '{{pixelId}}'
+            ]
+        },
+        {
+            type: 'loadScript',
+            src: "{{scriptSrc}}",
+            async: true
+        }
+    ]
+};
+function xPixel({ pixelId, scriptSrc }) {
+    const resolved = resolveManifest(xPixelManifest, {
+        pixelId,
+        scriptSrc: scriptSrc ?? 'https://static.ads-twitter.com/uwt.js'
+    });
+    return resolved;
 }
 const xPixelEvent = (eventId, metadata)=>window.twq?.('event', eventId, metadata);
-export { xPixel, xPixelEvent };
+export { xPixel, xPixelEvent, xPixelManifest };

package/dist-types/databuddy.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 {
         databuddy?: {
@@ -20,6 +20,71 @@ declare global {
         };
     }
 }
+/**
+ * DataBuddy vendor manifest.
+ *
+ * DataBuddy always loads but controls tracking via its `options.disabled` flag.
+ * Config is seeded via `window.databuddyConfig` before the script loads.
+ */
+export declare const databuddyManifest: {
+    readonly vendor: "databuddy";
+    readonly category: "measurement";
+    readonly alwaysLoad: true;
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly async: true;
+        readonly attributes: {
+            readonly crossorigin: "anonymous";
+            readonly 'data-client-id': "{{clientId}}";
+            readonly 'data-api-url': "{{apiUrl}}";
+        };
+    }];
+    readonly onBeforeLoadGranted: [{
+        readonly type: "setGlobal";
+        readonly name: "databuddyConfig";
+        readonly value: "{{configWhenGranted}}";
+        readonly ifUndefined: true;
+    }];
+    readonly onBeforeLoadDenied: [{
+        readonly type: "setGlobal";
+        readonly name: "databuddyConfig";
+        readonly value: "{{configWhenDenied}}";
+        readonly ifUndefined: true;
+    }];
+    readonly onLoadGranted: [{
+        readonly type: "setGlobalPath";
+        readonly path: ["databuddy", "options", "disabled"];
+        readonly value: false;
+    }];
+    readonly onLoadDenied: [{
+        readonly type: "setGlobalPath";
+        readonly path: ["databuddy", "options", "disabled"];
+        readonly value: true;
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "setGlobal";
+        readonly name: "databuddyConfig";
+        readonly value: "{{configWhenGranted}}";
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "setGlobalPath";
+        readonly path: ["databuddy", "options", "disabled"];
+        readonly value: false;
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "setGlobal";
+        readonly name: "databuddyConfig";
+        readonly value: "{{configWhenDenied}}";
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "setGlobalPath";
+        readonly path: ["databuddy", "options", "disabled"];
+        readonly value: true;
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface DatabuddyConsentOptions {
     /**
      * Your Databuddy client ID.
@@ -35,49 +100,21 @@ export interface DatabuddyConsentOptions {
      * @default 'https://cdn.databuddy.cc/databuddy.js'
      */
     scriptUrl?: string;
-    /**
-     * Additional configuration options for Databuddy.
-     * @example { trackScreenViews: true, trackOutgoingLinks: true }
-     */
-    options?: Record<string, unknown>;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'databuddy'
-     * - `category`: 'measurement'
-     */
-    script?: Partial<Script>;
+    /** Databuddy config object to seed when consent is granted at load time. */
+    configWhenGranted: Record<string, unknown>;
+    /** Databuddy config object to seed when consent is denied at load time. */
+    configWhenDenied: Record<string, unknown>;
 }
 /**
- * Loads the Databuddy script and manages consent state through a comprehensive lifecycle.
- *
- * This function orchestrates consent-aware analytics by coordinating between c15t's consent
- * state and Databuddy's tracking behavior. The consent management lifecycle works as follows:
- *
- * 1. **Before Script Load** (`onBeforeLoad`): Seeds `window.databuddyConfig` with the client
- *    configuration, including setting `disabled: !hasConsent` to ensure Databuddy initializes
- *    in the correct state. The Databuddy script reads this configuration object on initialization.
- *
- * 2. **On Script Load** (`onLoad`): After Databuddy has initialized, verifies that
- *    `window.databuddy.options.disabled` matches the current consent state by calling
- *    `handleConsentOpt()`.
+ * Loads the Databuddy script and manages consent state declaratively via the manifest runtime.
  *
- * 3. **On Consent Change** (`onConsentChange`): Dynamically toggles `window.databuddy.options.disabled`
- *    to enable tracking when consent is granted or disable tracking when consent is revoked.
- *    This ensures real-time compliance with user preferences.
- *
- * The script always loads (`alwaysLoad: true`) but tracking is controlled via the `disabled` flag,
- * allowing Databuddy to remain present in the DOM while respecting consent boundaries.
+ * The script always loads (`alwaysLoad: true`) but tracking is controlled via the `disabled`
+ * flag on Databuddy's global config/runtime objects, allowing the vendor to stay present in
+ * the DOM while respecting consent boundaries.
  *
  * @param options - Configuration for the Databuddy consent script
  * @returns The Databuddy script configuration object for c15t's script loader
  *
- * @throws This function does not throw errors directly. However, network failures or script
- * loading errors may cause the Databuddy script to fail silently without initializing
- * `window.databuddy`. The lifecycle callbacks handle these cases gracefully by checking for
- * the presence of `window.databuddy` before attempting to modify its state.
- *
  * @example
  * ```ts
  * import { configureConsentManager } from 'c15t';
@@ -87,13 +124,17 @@ export interface DatabuddyConsentOptions {
  *   scripts: [
  *     databuddy({
  *       clientId: 'db_1234567890abcdef',
- *       // scriptUrl: 'https://cdn.databuddy.cc/databuddy.js', // Optional, defaults to cdn.databuddy.cc
- *       // apiUrl: 'https://basket.databuddy.cc', // Optional, defaults to basket.databuddy.cc
- *       options: {
+ *       configWhenGranted: {
+ *         clientId: 'db_1234567890abcdef',
  *         trackScreenViews: true,
  *         trackOutgoingLinks: true,
  *         trackPerformance: true,
  *         samplingRate: 1.0,
+ *         disabled: false,
+ *       },
+ *       configWhenDenied: {
+ *         clientId: 'db_1234567890abcdef',
+ *         disabled: true,
  *       },
  *     }),
  *   ],

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

@@ -0,0 +1,3 @@
+import type { ResolvedManifest, VendorManifest } from '../types';
+export declare function interpolateValue(value: unknown, config: Record<string, unknown>): unknown;
+export declare function compileManifest(manifest: VendorManifest, config?: Record<string, unknown>): ResolvedManifest;

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

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

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

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

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

@@ -1,29 +1,61 @@
-import type { ConsentState, Script } from '../../core/dist-types/index.d.ts';
+import type { Script } from 'c15t';
 declare global {
     interface Window {
         dataLayer: unknown[];
         gtag: (...args: unknown[]) => void;
     }
 }
-interface GTMConsentConfiguration {
-    ad_storage: 'granted' | 'denied';
-    ad_personalization: 'granted' | 'denied';
-    ad_user_data: 'granted' | 'denied';
-    analytics_storage: 'granted' | 'denied';
-    personalization_storage: 'granted' | 'denied';
-    functionality_storage: 'granted' | 'denied';
-    security_storage: 'granted' | 'denied';
-}
-export declare const DEFAULT_GTM_CONSENT_CONFIG: GTMConsentConfiguration;
 /**
- * Converts ConsentState to GTM consent configuration
- *
- * @param consentState - The application's consent state
- * @returns GTM-compatible consent configuration
+ * Google Tag Manager vendor manifest.
  *
- * @see {@link CONSENT_STATE_TO_GTM_MAPPING} for the mapping logic
+ * Defines GTM as a declarative integration:
+ * - Initializes dataLayer and gtag function before the container loads
+ * - Maps c15t consent categories to Google Consent Mode v2 types
+ * - Signals consent state via `gtag('consent', 'default'|'update', ...)`
  */
-export declare function mapConsentStateToGTM(consentState: ConsentState): GTMConsentConfiguration;
+export declare const googleTagManagerManifest: {
+    readonly vendor: "google-tag-manager";
+    readonly category: "necessary";
+    readonly alwaysLoad: 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: "pushToQueue";
+        readonly queue: "dataLayer";
+        readonly value: {
+            readonly 'gtm.start': "{{loadTime}}";
+            readonly event: "gtm.js";
+        };
+    }, {
+        readonly type: "loadScript";
+        readonly src: "https://www.googletagmanager.com/gtm.js?id={{id}}";
+        readonly async: true;
+    }];
+    readonly onConsentChange: [{
+        readonly type: "callGlobal";
+        readonly global: "gtag";
+        readonly args: ["event", "{{updateEventName}}"];
+    }];
+    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 GoogleTagManagerOptions {
     /**
      * Your Google Tag Manager container ID. Begins with 'GTM-'.
@@ -31,24 +63,28 @@ export interface GoogleTagManagerOptions {
      */
     id: string;
     /**
-     * Update Event Name
-     * A custom event name used as a trigger to load your script once the consent has been updated.
+     * Custom event name fired after consent updates.
+     * Can be used as a trigger in GTM to load scripts once consent is updated.
      *
      * @default 'consent-update'
-     * @example 'consent-update'
      */
     updateEventName?: string;
     /**
-     * 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 values:
-     * - `id`: 'google-tag-manager'
-     * - `src`: `https://www.googletagmanager.com/gtm.js?id=${id}`
-     * - `category`: 'necessary' (You control what scripts get loaded via Google Tag Manager)
-     * - `alwaysLoad`: true
-     * - `async`: true
+     * @default
+     * ```ts
+     * {
+     *   necessary: ['security_storage'],
+     *   functionality: ['functionality_storage'],
+     *   measurement: ['analytics_storage'],
+     *   marketing: ['ad_storage', 'ad_user_data', 'ad_personalization'],
+     *   experience: ['personalization_storage'],
+     * }
+     * ```
      */
-    script?: Partial<Script>;
+    consentMapping?: Record<string, string[]>;
 }
 /**
  * Creates a Google Tag Manager script.
@@ -58,5 +94,4 @@ export interface GoogleTagManagerOptions {
  * @param options - The options for the Google Tag Manager script.
  * @returns The Google Tag Manager script.
  */
-export declare function googleTagManager({ id, script, updateEventName, }: GoogleTagManagerOptions): Script;
-export {};
+export declare function googleTagManager({ id, updateEventName, consentMapping, }: GoogleTagManagerOptions): Script;