@c15t/scripts 1.0.1 → 1.1.0-rc.1

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,31 +25,61 @@ 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(),
-        onDelete: (rest)=>{
-            delete window.twq;
-            if (script?.onDelete) script.onDelete(rest);
+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;
-for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+exports.xPixelManifest = __webpack_exports__.xPixelManifest;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
     "xPixel",
-    "xPixelEvent"
-].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+    "xPixelEvent",
+    "xPixelManifest"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true
 });

package/dist/x-pixel.js

@@ -1,18 +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(),
-        onDelete: (rest)=>{
-            delete window.twq;
-            if (script?.onDelete) script.onDelete(rest);
+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

@@ -0,0 +1,144 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        databuddy?: {
+            track: (eventName: string, properties?: Record<string, unknown>) => void;
+            screenView: (screenName?: string, properties?: Record<string, unknown>) => void;
+            clear: () => void;
+            flush: () => void;
+            setGlobalProperties: (properties: Record<string, unknown>) => void;
+            trackCustomEvent: (eventName: string, properties?: Record<string, unknown>) => void;
+            options: {
+                disabled: boolean;
+                [key: string]: unknown;
+            };
+        };
+        databuddyConfig?: {
+            clientId?: string;
+            apiUrl?: string;
+            [key: string]: unknown;
+        };
+    }
+}
+/**
+ * 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.
+     */
+    clientId: string;
+    /**
+     * Your Databuddy API URL.
+     * @default 'https://basket.databuddy.cc'
+     */
+    apiUrl?: string;
+    /**
+     * The Databuddy script URL.
+     * @default 'https://cdn.databuddy.cc/databuddy.js'
+     */
+    scriptUrl?: string;
+    /** 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 declaratively via the manifest runtime.
+ *
+ * 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
+ *
+ * @example
+ * ```ts
+ * import { configureConsentManager } from 'c15t';
+ * import { databuddy } from '@c15t/scripts/databuddy';
+ *
+ * configureConsentManager({
+ *   scripts: [
+ *     databuddy({
+ *       clientId: 'db_1234567890abcdef',
+ *       configWhenGranted: {
+ *         clientId: 'db_1234567890abcdef',
+ *         trackScreenViews: true,
+ *         trackOutgoingLinks: true,
+ *         trackPerformance: true,
+ *         samplingRate: 1.0,
+ *         disabled: false,
+ *       },
+ *       configWhenDenied: {
+ *         clientId: 'db_1234567890abcdef',
+ *         disabled: true,
+ *       },
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+export declare function databuddy(options: DatabuddyConsentOptions): Script;

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

@@ -0,0 +1,97 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        dataLayer: unknown[];
+        gtag: (...args: unknown[]) => void;
+    }
+}
+/**
+ * Google Tag Manager vendor manifest.
+ *
+ * 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 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-'.
+     * @example `GTM-1234XXX`
+     */
+    id: string;
+    /**
+     * 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'
+     */
+    updateEventName?: string;
+    /**
+     * 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[]>;
+}
+/**
+ * Creates a Google Tag Manager script.
+ * GTM can be used for managing the consent of other scripts via Google Tag Manager consent mode.
+ * We recommend using c15t's script loader instead so your script logic is centralised.
+ *
+ * @param options - The options for the Google Tag Manager script.
+ * @returns The Google Tag Manager script.
+ */
+export declare function googleTagManager({ id, updateEventName, consentMapping, }: GoogleTagManagerOptions): Script;

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

@@ -0,0 +1,96 @@
+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
+     * @example `G-XXXXXXX`
+     */
+    id: string;
+    /**
+     * The consent category to use for the gtag script. This is typically marketing (Ads & Floodlight) or measurement (Analytics)
+     * @example 'marketing'
+     */
+    category: AllConsentNames;
+    /**
+     * 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.
+     *
+     * Prefer manifest-backed options instead of this generic override bag.
+     * @deprecated
+     */
+    script?: Partial<Script>;
+}
+/**
+ * Creates a Google Tag (gtag.js) script.
+ * Allows you to send data website to linked Google products like Analytics, Ads & Floodlight.
+ *
+ * @param options - The options for the gtag script.
+ * @returns The Google Tag Manager 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

@@ -0,0 +1,79 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        lintrk: ((...args: unknown[]) => void) & {
+            q?: unknown[][];
+        };
+        _linkedin_partner_id?: string;
+        _linkedin_data_partner_ids?: string[];
+        ORIBILI?: {
+            _DEBUG?: {
+                disableScript?: () => void;
+            };
+        };
+    }
+}
+/**
+ * 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;
+    /** LinkedIn Insights loader URL. */
+    scriptSrc?: string;
+}
+/**
+ * LinkedIn Insights Script
+ *
+ * @param options - The options for the LinkedIn Insights script
+ * @returns The LinkedIn Insights script configuration
+ *
+ * @example
+ * ```ts
+ * const linkedinInsightsScript = linkedinInsights({
+ *   id: '123456789012345',
+ * });
+ * ```
+ *
+ * @see {@link https://business.linkedin.com/marketing-solutions/ad-libraries/insights} LinkedIn Insights documentation
+ */
+export declare function linkedinInsights({ id, scriptSrc, }: LinkedInInsightsOptions): Script;