@c15t/scripts 2.2.0 → 3.0.0-alpha.0

package/dist-types/vendors/ads-and-pixels/snapchat-pixel.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 export type SnapchatPixelEventName = 'PAGE_VIEW' | 'VIEW_CONTENT' | 'ADD_CART' | 'PURCHASE' | 'SIGN_UP' | 'SAVE' | 'START_CHECKOUT' | 'APP_OPEN' | 'ADD_BILLING' | 'SEARCH' | 'SUBSCRIBE' | 'AD_CLICK' | 'AD_VIEW' | 'COMPLETE_TUTORIAL' | 'LEVEL_COMPLETE' | 'INVITE' | 'LOGIN' | 'SHARE' | 'RESERVE' | 'ACHIEVEMENT_UNLOCKED' | 'ADD_TO_WISHLIST' | 'SPENT_CREDITS' | 'RATE' | 'START_TRIAL' | 'LIST_VIEW';
 export interface SnapchatPixelEventProperties {
     /** Total monetary value for commerce events such as `PURCHASE`. */
@@ -38,11 +38,11 @@ export interface SnapchatPixelEventProperties {
     event_tag?: string;
     [key: string]: unknown;
 }
-type SnapchatPixelFunction = {
-    (command: 'track', eventName: SnapchatPixelEventName | (string & {}), properties?: SnapchatPixelEventProperties): void;
+interface SnapchatPixelFunction {
+    (command: 'track', eventName: SnapchatPixelEventName | (string & Record<never, never>), properties?: SnapchatPixelEventProperties): void;
     (command: 'init', pixelId: string, config?: Record<string, unknown>): void;
     (command: string, ...args: unknown[]): void;
-};
+}
 declare global {
     interface Window {
         snaptr?: SnapchatPixelFunction & {
@@ -64,37 +64,37 @@ declare global {
 export declare const snapchatPixelManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'snapchat-pixel';
-    readonly category: 'marketing';
     readonly bootstrap: [{
-        readonly type: 'defineStubFunction';
+        readonly aliases: ["_snaptr"];
+        readonly dispatchProperty: 'handleRequest';
+        readonly ifUndefined: true;
         readonly name: 'snaptr';
+        readonly properties: {
+            readonly loaded: true;
+            readonly version: '1.0';
+        };
         readonly queue: {
             readonly property: 'queue';
         };
-        readonly dispatchProperty: 'handleRequest';
         readonly queueFormat: 'array';
-        readonly aliases: ["_snaptr"];
         readonly selfReferences: ["push"];
-        readonly properties: {
-            readonly loaded: true;
-            readonly version: '1.0';
-        };
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'callGlobal';
-        readonly global: 'snaptr';
         readonly args: ["init", "{{pixelId}}"];
-    }, {
-        readonly type: 'callGlobal';
         readonly global: 'snaptr';
+        readonly type: 'callGlobal';
+    }, {
         readonly args: ["track", "PAGE_VIEW"];
+        readonly global: 'snaptr';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'snapchat-pixel';
 };
 export interface SnapchatPixelOptions {
     /**
@@ -128,7 +128,7 @@ export interface SnapchatPixelOptions {
  * @returns A resolved c15t `Script` configuration that defines the Snapchat
  *   queue stub, runs `init` (and optionally `PAGE_VIEW`), and then loads the
  *   Snapchat SDK script URL.
- * @throws `resolveManifest` may throw when required placeholders cannot be
+ * @throws {Error} `resolveManifest` may throw when required placeholders cannot be
  *   resolved (for example, when `pixelId` is missing/empty) or when provided
  *   manifest values are invalid for interpolation.
  *
@@ -149,7 +149,7 @@ export interface SnapchatPixelOptions {
  * });
  * ```
  */
-export declare function snapchatPixel({ pixelId, initOptions, trackPageView, scriptUrl, }: SnapchatPixelOptions): Script;
+export declare const snapchatPixel: ({ pixelId, initOptions, trackPageView, scriptUrl, }: SnapchatPixelOptions) => Script;
 /**
  * Tracks a Snapchat Pixel event.
  *
@@ -167,5 +167,5 @@ export declare function snapchatPixel({ pixelId, initOptions, trackPageView, scr
  * });
  * ```
  */
-export declare const snapchatPixelEvent: (eventName: SnapchatPixelEventName | (string & {}), properties?: SnapchatPixelEventProperties) => void;
+export declare const snapchatPixelEvent: (eventName: SnapchatPixelEventName | (string & Record<never, never>), properties?: SnapchatPixelEventProperties) => void;
 export {};

package/dist-types/vendors/ads-and-pixels/tiktok-pixel.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 interface TikTokPixelFunction {
     grantConsent: () => void;
     revokeConsent: () => void;
@@ -31,51 +31,51 @@ declare global {
 export declare const tiktokPixelManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'tiktok-pixel';
-    readonly category: 'marketing';
-    readonly persistAfterConsentRevoked: true;
+    readonly afterLoad: [{
+        readonly global: 'ttq';
+        readonly method: 'grantConsent';
+        readonly type: 'callGlobal';
+    }];
     readonly bootstrap: [{
-        readonly type: 'setGlobal';
         readonly name: 'TiktokAnalyticsObject';
+        readonly type: 'setGlobal';
         readonly value: 'ttq';
     }, {
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'ttq';
+        readonly type: 'setGlobal';
         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 target: 'ttq';
+        readonly type: 'defineQueueMethods';
     }];
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'callGlobal';
         readonly global: 'ttq';
         readonly method: 'grantConsent';
-    }, {
         readonly type: 'callGlobal';
+    }, {
         readonly global: 'ttq';
         readonly method: 'page';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq';
         readonly async: true;
+        readonly src: '{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq';
+        readonly type: 'loadScript';
     }];
-    readonly afterLoad: [{
-        readonly type: 'callGlobal';
+    readonly onConsentDenied: [{
         readonly global: 'ttq';
-        readonly method: 'grantConsent';
+        readonly method: 'revokeConsent';
+        readonly type: 'callGlobal';
     }];
     readonly onConsentGranted: [{
-        readonly type: 'callGlobal';
         readonly global: 'ttq';
         readonly method: 'grantConsent';
-    }];
-    readonly onConsentDenied: [{
         readonly type: 'callGlobal';
-        readonly global: 'ttq';
-        readonly method: 'revokeConsent';
     }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'tiktok-pixel';
 };
 export interface TikTokPixelOptions {
     /**
@@ -102,5 +102,5 @@ export interface TikTokPixelOptions {
  *
  * @see {@link https://ads.tiktok.com/help/article/tiktok-pixel} TikTok Pixel documentation
  */
-export declare function tiktokPixel({ pixelId, scriptSrc, }: TikTokPixelOptions): Script;
+export declare const tiktokPixel: ({ pixelId, scriptSrc, }: TikTokPixelOptions) => Script;
 export {};

package/dist-types/vendors/ads-and-pixels/x-pixel.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 export interface XPixelContent {
     /**
      * Type of the content
@@ -107,29 +107,29 @@ declare global {
 export declare const xPixelManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'x-pixel';
-    readonly category: 'marketing';
     readonly bootstrap: [{
-        readonly type: 'defineStubFunction';
-        readonly name: 'twq';
-        readonly queue: {
-            readonly property: 'queue';
-        };
         readonly dispatchProperty: 'exe';
+        readonly ifUndefined: true;
+        readonly name: 'twq';
         readonly properties: {
             readonly version: '1.1';
         };
-        readonly ifUndefined: true;
+        readonly queue: {
+            readonly property: 'queue';
+        };
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'callGlobal';
-        readonly global: 'twq';
         readonly args: ["config", "{{pixelId}}"];
+        readonly global: 'twq';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptSrc}}';
         readonly async: true;
+        readonly src: '{{scriptSrc}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'x-pixel';
 };
 export interface XPixelOptions {
     /**
@@ -157,13 +157,13 @@ export interface XPixelOptions {
  *
  * @see {@link https://business.x.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites} X conversion tracking documentation
  */
-export declare function xPixel({ pixelId, scriptSrc }: XPixelOptions): Script;
+export declare const xPixel: ({ pixelId, scriptSrc, }: XPixelOptions) => Script;
 /**
  * @param eventId - The event ID to track
  * @example 'tw-xxxx-xxxx'
  * @param metadata - Optional metadata to track
  *
- * @usage
+ * @example
  * ```ts
  * xPixelEvent('tw-xxxx-xxxx', {
  *   value: 200.00,

package/dist-types/vendors/analytics/adobe-analytics.d.ts

@@ -1,5 +1,5 @@
-import type { Script } from 'c15t';
-import { type VendorManifest } from '../../types';
+import type { Script } from '@c15t/core';
+import type { VendorManifest } from '../../types';
 declare global {
     interface Window {
         adobeDataLayer?: unknown[];
@@ -72,4 +72,4 @@ export interface AdobeAnalyticsOptions {
  * });
  * ```
  */
-export declare function adobeAnalytics(options: AdobeAnalyticsOptions): Script;
+export declare const adobeAnalytics: (options: AdobeAnalyticsOptions) => Script;

package/dist-types/vendors/analytics/ahrefs-analytics.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         AhrefsAnalytics?: {
@@ -19,16 +19,16 @@ declare global {
 export declare const ahrefsAnalyticsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'ahrefs-analytics';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
         readonly attributes: {
             readonly 'data-key': '{{key}}';
         };
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'ahrefs-analytics';
 };
 export interface AhrefsAnalyticsOptions {
     /**
@@ -59,4 +59,4 @@ export interface AhrefsAnalyticsOptions {
  * ahrefsAnalytics({ key: 'YOUR_PROJECT_KEY' });
  * ```
  */
-export declare function ahrefsAnalytics(options: AhrefsAnalyticsOptions): Script;
+export declare const ahrefsAnalytics: (options: AhrefsAnalyticsOptions) => Script;

package/dist-types/vendors/analytics/amplitude.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Browser SDK 2 version used by the default Amplitude CDN loader URL.
  *
@@ -127,31 +127,30 @@ declare global {
 export declare const amplitudeManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'amplitude';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'amplitude';
+        readonly type: 'setGlobal';
         readonly value: {
-            readonly _q: readonly [];
             readonly _iq: {};
+            readonly _q: readonly [];
             readonly invoked: true;
         };
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'defineQueueClass';
-        readonly target: 'amplitude';
+        readonly methods: ["set", "setOnce", "add", "append", "prepend", "preInsert", "postInsert", "remove", "unset", "clearAll", "getUserProperties"];
         readonly name: 'Identify';
         readonly queueProperty: '_q';
-        readonly methods: ["set", "setOnce", "add", "append", "prepend", "preInsert", "postInsert", "remove", "unset", "clearAll", "getUserProperties"];
-    }, {
-        readonly type: 'defineQueueMethods';
         readonly target: 'amplitude';
+        readonly type: 'defineQueueClass';
+    }, {
+        readonly methods: ["init", "track", "identify", "flush"];
         readonly queue: {
             readonly property: '_q';
         };
         readonly queueFormat: 'wrappedMethodCall';
-        readonly methods: ["init", "track", "identify", "flush"];
+        readonly target: 'amplitude';
+        readonly type: 'defineQueueMethods';
     }, {
         readonly type: 'defineQueueMethods';
         readonly target: 'amplitude';
@@ -161,33 +160,34 @@ export declare const amplitudeManifest: {
         readonly queueFormat: 'voidMethodCall';
         readonly methods: ["setUserId", "setOptOut"];
     }, {
-        readonly type: 'callGlobal';
+        readonly args: ["{{apiKey}}", "{{initOptions}}"];
         readonly global: 'amplitude';
         readonly method: 'init';
-        readonly args: ["{{apiKey}}", "{{initOptions}}"];
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
-    readonly onLoadDenied: [{
-        readonly type: 'callGlobal';
+    readonly onConsentDenied: [{
+        readonly args: [true];
         readonly global: 'amplitude';
         readonly method: 'setOptOut';
-        readonly args: [true];
+        readonly type: 'callGlobal';
     }];
     readonly onConsentGranted: [{
-        readonly type: 'callGlobal';
+        readonly args: [false];
         readonly global: 'amplitude';
         readonly method: 'setOptOut';
-        readonly args: [false];
-    }];
-    readonly onConsentDenied: [{
         readonly type: 'callGlobal';
+    }];
+    readonly onLoadDenied: [{
+        readonly args: [true];
         readonly global: 'amplitude';
         readonly method: 'setOptOut';
-        readonly args: [true];
+        readonly type: 'callGlobal';
     }];
+    readonly vendor: 'amplitude';
 };
 export interface AmplitudeOptions {
     /** Amplitude project API key. */
@@ -231,4 +231,4 @@ export interface AmplitudeOptions {
  * });
  * ```
  */
-export declare function amplitude({ apiKey, initOptions, scriptUrl, }: AmplitudeOptions): Script;
+export declare const amplitude: ({ apiKey, initOptions, scriptUrl, }: AmplitudeOptions) => Script;

package/dist-types/vendors/analytics/clearbit.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Clearbit vendor manifest.
  *
@@ -11,15 +11,15 @@ import type { Script } from 'c15t';
 export declare const clearbitManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'clearbit';
     readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly attributes: {
             readonly referrerpolicy: 'strict-origin-when-cross-origin';
         };
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'clearbit';
 };
 export interface ClearbitOptions {
     /**
@@ -57,4 +57,4 @@ export interface ClearbitOptions {
  * });
  * ```
  */
-export declare function clearbit(options: ClearbitOptions): Script;
+export declare const clearbit: (options: ClearbitOptions) => Script;

package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         __cfBeacon?: {
@@ -17,16 +17,16 @@ declare global {
 export declare const cloudflareWebAnalyticsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'cloudflare-web-analytics';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
-        readonly defer: true;
         readonly attributes: {
             readonly 'data-cf-beacon': '{{beaconConfig}}';
         };
+        readonly defer: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'cloudflare-web-analytics';
 };
 export interface CloudflareWebAnalyticsOptions {
     /**
@@ -64,4 +64,4 @@ export interface CloudflareWebAnalyticsOptions {
  * });
  * ```
  */
-export declare function cloudflareWebAnalytics(options: CloudflareWebAnalyticsOptions): Script;
+export declare const cloudflareWebAnalytics: (options: CloudflareWebAnalyticsOptions) => Script;

package/dist-types/vendors/analytics/databuddy.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         databuddy?: {
@@ -29,61 +29,61 @@ declare global {
 export declare const databuddyManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'databuddy';
-    readonly category: 'measurement';
     readonly alwaysLoad: true;
+    readonly category: 'measurement';
     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 'data-client-id': '{{clientId}}';
         };
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
-    readonly onBeforeLoadGranted: [{
+    readonly onBeforeLoadDenied: [{
+        readonly ifUndefined: true;
+        readonly name: 'databuddyConfig';
         readonly type: 'setGlobal';
+        readonly value: '{{configWhenDenied}}';
+    }];
+    readonly onBeforeLoadGranted: [{
+        readonly ifUndefined: true;
         readonly name: 'databuddyConfig';
+        readonly type: 'setGlobal';
         readonly value: '{{configWhenGranted}}';
-        readonly ifUndefined: true;
     }];
-    readonly onBeforeLoadDenied: [{
-        readonly type: 'setGlobal';
+    readonly onConsentDenied: [{
+        readonly ifUndefined: false;
         readonly name: 'databuddyConfig';
+        readonly type: 'setGlobal';
         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 ifUndefined: false;
         readonly name: 'databuddyConfig';
+        readonly type: 'setGlobal';
         readonly value: '{{configWhenGranted}}';
-        readonly ifUndefined: false;
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["databuddy", "options", "disabled"];
+        readonly type: 'setGlobalPath';
         readonly value: false;
     }];
-    readonly onConsentDenied: [{
-        readonly type: 'setGlobal';
-        readonly name: 'databuddyConfig';
-        readonly value: '{{configWhenDenied}}';
-        readonly ifUndefined: false;
-    }, {
-        readonly type: 'setGlobalPath';
+    readonly onLoadDenied: [{
         readonly path: ["databuddy", "options", "disabled"];
+        readonly type: 'setGlobalPath';
         readonly value: true;
     }];
+    readonly onLoadGranted: [{
+        readonly path: ["databuddy", "options", "disabled"];
+        readonly type: 'setGlobalPath';
+        readonly value: false;
+    }];
+    readonly vendor: 'databuddy';
 };
 export interface DatabuddyConsentOptions {
     /**
@@ -117,10 +117,13 @@ export interface DatabuddyConsentOptions {
  *
  * @example
  * ```ts
- * import { configureConsentManager } from 'c15t';
+ * import { createConsentKernel } from 'c15t';
+ * import { createScriptLoader } from 'c15t/modules/script-loader';
  * import { databuddy } from '@c15t/scripts/databuddy';
  *
- * configureConsentManager({
+ * const kernel = createConsentKernel();
+ * const loader = createScriptLoader({
+ *   kernel,
  *   scripts: [
  *     databuddy({
  *       clientId: 'db_1234567890abcdef',
@@ -141,4 +144,4 @@ export interface DatabuddyConsentOptions {
  * });
  * ```
  */
-export declare function databuddy(options: DatabuddyConsentOptions): Script;
+export declare const databuddy: (options: DatabuddyConsentOptions) => Script;

package/dist-types/vendors/analytics/fathom-analytics.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         fathom?: {
@@ -25,20 +25,20 @@ declare global {
 export declare const fathomAnalyticsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'fathom-analytics';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
-        readonly defer: true;
         readonly attributes: {
-            readonly 'data-site': '{{site}}';
-            readonly 'data-spa': '{{spa}}';
             readonly 'data-auto': '{{autoAttribute}}';
             readonly 'data-canonical': '{{canonicalAttribute}}';
             readonly 'data-honor-dnt': '{{honorDntAttribute}}';
+            readonly 'data-site': '{{site}}';
+            readonly 'data-spa': '{{spa}}';
         };
+        readonly defer: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'fathom-analytics';
 };
 export interface FathomAnalyticsOptions {
     /**
@@ -87,4 +87,4 @@ export interface FathomAnalyticsOptions {
  * });
  * ```
  */
-export declare function fathomAnalytics(options: FathomAnalyticsOptions): Script;
+export declare const fathomAnalytics: (options: FathomAnalyticsOptions) => Script;