@c15t/scripts 2.1.0 → 2.2.0-canary-20260804162155

package/dist-types/types.d.ts

@@ -12,11 +12,11 @@ export interface RuntimeValue {
 }
 export declare const runtimeDateValue: {
     readonly kind: "c15t.runtime-value";
-    readonly value: "date";
+    readonly value: 'date';
 };
 export declare const runtimeTimestampValue: {
     readonly kind: "c15t.runtime-value";
-    readonly value: "timestamp";
+    readonly value: 'timestamp';
 };
 export interface ManifestContract {
     kind: typeof VENDOR_MANIFEST_KIND;
@@ -119,6 +119,8 @@ export interface SetGlobalPathStep {
     path: string[];
     /** Value to assign at the target path */
     value: unknown;
+    /** Only assign while the root global is still a snippet queue array. */
+    ifGlobalIsQueue?: boolean;
 }
 export interface DefineQueueMethodsStep {
     type: 'defineQueueMethods';
@@ -134,6 +136,40 @@ export interface DefineQueueMethodsStep {
         global?: never;
         property: string;
     };
+    /**
+     * Format used for each queued method call.
+     *
+     * - `tuple` pushes `[methodName, ...args]`, matching classic array queues.
+     * - `methodCall` pushes `{ name, args, resolve }` and returns a `Promise`,
+     *   matching SDK loaders that replay named calls and resolve the original
+     *   pre-load promise after the real method runs.
+     * - `wrappedMethodCall` queues like `methodCall` but returns
+     *   `{ promise }`, matching Amplitude's snippet contract where queued
+     *   proxy calls expose the pending promise on a `promise` property.
+     * - `voidMethodCall` queues like `methodCall` but returns nothing,
+     *   matching snippet methods the vendor treats as synchronous.
+     * - `callback` pushes `{ name, fn }`, where `fn` replays the captured call
+     *   against the current global target, matching loaders that own a
+     *   ready-callback queue.
+     *
+     * @default 'tuple'
+     */
+    queueFormat?: 'tuple' | 'methodCall' | 'wrappedMethodCall' | 'voidMethodCall' | 'callback';
+}
+export interface DefineQueueClassStep {
+    type: 'defineQueueClass';
+    /** Global object that receives the queued helper class. */
+    target: string;
+    /** Constructor property name to define on the target object. */
+    name: string;
+    /**
+     * Instance property that stores queued helper method calls.
+     *
+     * @default '_q'
+     */
+    queueProperty?: string;
+    /** Helper instance method names to attach to the constructor prototype. */
+    methods: string[];
 }
 export type GlobalMethodBehavior = {
     name: string;
@@ -148,6 +184,8 @@ export interface DefineGlobalMethodsStep {
     /** Global object name to receive the methods */
     target: string;
     methods: Array<GlobalMethodBehavior>;
+    /** Only define methods while the target is still a snippet queue array. */
+    ifGlobalIsQueue?: boolean;
 }
 export interface ConstructGlobalStep {
     type: 'constructGlobal';
@@ -163,13 +201,17 @@ export interface ConstructGlobalStep {
      */
     copyAssignedValueToArgProperty?: string;
 }
-export type ManifestStep = LoadScriptStep | SetGlobalStep | DefineQueueFunctionStep | DefineStubFunctionStep | CallGlobalStep | PushToQueueStep | SetGlobalPathStep | DefineQueueMethodsStep | DefineGlobalMethodsStep | ConstructGlobalStep;
+export type ManifestStep = LoadScriptStep | SetGlobalStep | DefineQueueFunctionStep | DefineStubFunctionStep | CallGlobalStep | PushToQueueStep | SetGlobalPathStep | DefineQueueMethodsStep | DefineQueueClassStep | DefineGlobalMethodsStep | ConstructGlobalStep;
 /**
  * Consent signal type determines how consent state is communicated to the vendor.
  *
  * - `'gtag'` — Google Consent Mode pattern: calls `gtag('consent', 'default'|'update', state)`
+ * - `'rudderstack'` — RudderStack consent-management pattern: calls
+ *   `rudderanalytics.consent({ consentManagement: { enabled, provider: 'custom',
+ *   allowedConsentIds, deniedConsentIds } })` with the mapping's consent IDs
+ *   partitioned by the current c15t consent state
  */
-export type ConsentSignalType = 'gtag';
+export type ConsentSignalType = 'gtag' | 'rudderstack';
 /**
  * A declarative definition of a vendor integration.
  *

package/dist-types/vendors/ads-and-pixels/linkedin-insights.d.ts

@@ -28,37 +28,37 @@ declare global {
  * via structured startup steps.
  */
 export declare const linkedinInsightsManifest: {
-    readonly vendor: "linkedin-insights";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'linkedin-insights';
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: "setGlobal";
-        readonly name: "_linkedin_partner_id";
-        readonly value: "{{id}}";
+        readonly type: 'setGlobal';
+        readonly name: '_linkedin_partner_id';
+        readonly value: '{{id}}';
         readonly ifUndefined: false;
     }, {
-        readonly type: "setGlobal";
-        readonly name: "_linkedin_data_partner_ids";
+        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: 'pushToQueue';
+        readonly queue: '_linkedin_data_partner_ids';
+        readonly value: '{{id}}';
     }, {
-        readonly type: "defineStubFunction";
-        readonly name: "lintrk";
+        readonly type: 'defineStubFunction';
+        readonly name: 'lintrk';
         readonly queue: {
-            readonly property: "q";
+            readonly property: 'q';
         };
-        readonly queueFormat: "array";
+        readonly queueFormat: 'array';
         readonly ifUndefined: true;
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptSrc}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptSrc}}';
         readonly async: true;
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface LinkedInInsightsOptions {
     /**

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

@@ -126,53 +126,53 @@ declare global {
  * stub and provides a consent API via `fbq('consent', 'grant'|'revoke')`.
  */
 export declare const metaPixelManifest: {
-    readonly vendor: "meta-pixel";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'meta-pixel';
+    readonly category: 'marketing';
     readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "fbq";
+        readonly type: 'defineStubFunction';
+        readonly name: 'fbq';
         readonly queue: {
-            readonly property: "queue";
+            readonly property: 'queue';
         };
-        readonly dispatchProperty: "callMethod";
+        readonly dispatchProperty: 'callMethod';
         readonly selfReferences: ["push"];
         readonly aliases: ["_fbq"];
         readonly properties: {
             readonly loaded: true;
-            readonly version: "2.0";
+            readonly version: '2.0';
         };
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "callGlobal";
-        readonly global: "fbq";
+        readonly type: 'callGlobal';
+        readonly global: 'fbq';
         readonly args: ["consent", "grant"];
     }, {
-        readonly type: "callGlobal";
-        readonly global: "fbq";
+        readonly type: 'callGlobal';
+        readonly global: 'fbq';
         readonly args: ["init", "{{pixelId}}"];
     }, {
-        readonly type: "callGlobal";
-        readonly global: "fbq";
+        readonly type: 'callGlobal';
+        readonly global: 'fbq';
         readonly args: ["track", "PageView"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptSrc}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptSrc}}';
         readonly async: true;
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "fbq";
+        readonly type: 'callGlobal';
+        readonly global: 'fbq';
         readonly args: ["consent", "grant"];
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "fbq";
+        readonly type: 'callGlobal';
+        readonly global: 'fbq';
         readonly args: ["consent", "revoke"];
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface MetaPixelOptions {
     /**

package/dist-types/vendors/ads-and-pixels/microsoft-uet.d.ts

@@ -11,70 +11,70 @@ declare global {
  * `window.uetq.push('consent', 'default'|'update', consentState)`.
  */
 export declare const microsoftUetManifest: {
-    readonly vendor: "microsoft-uet";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'microsoft-uet';
+    readonly category: 'marketing';
     readonly alwaysLoad: true;
     readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: "setGlobal";
-        readonly name: "uetq";
+        readonly type: 'setGlobal';
+        readonly name: 'uetq';
         readonly value: readonly [];
         readonly ifUndefined: true;
     }];
     readonly onBeforeLoadGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "uetq";
-        readonly method: "push";
+        readonly type: 'callGlobal';
+        readonly global: 'uetq';
+        readonly method: 'push';
         readonly args: ["consent", "default", {
-            readonly ad_storage: "granted";
+            readonly ad_storage: 'granted';
         }];
     }];
     readonly onBeforeLoadDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "uetq";
-        readonly method: "push";
+        readonly type: 'callGlobal';
+        readonly global: 'uetq';
+        readonly method: 'push';
         readonly args: ["consent", "default", {
-            readonly ad_storage: "denied";
+            readonly ad_storage: 'denied';
         }];
     }];
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptSrc}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptSrc}}';
         readonly async: true;
     }];
     readonly afterLoad: [{
-        readonly type: "constructGlobal";
-        readonly constructor: "UET";
-        readonly assignTo: "uetq";
+        readonly type: 'constructGlobal';
+        readonly constructor: 'UET';
+        readonly assignTo: 'uetq';
         readonly args: [{
-            readonly ti: "{{id}}";
+            readonly ti: '{{id}}';
             readonly enableAutoSpaTracking: true;
         }];
-        readonly copyAssignedValueToArgProperty: "q";
+        readonly copyAssignedValueToArgProperty: 'q';
     }, {
-        readonly type: "callGlobal";
-        readonly global: "uetq";
-        readonly method: "push";
+        readonly type: 'callGlobal';
+        readonly global: 'uetq';
+        readonly method: 'push';
         readonly args: ["pageLoad"];
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "uetq";
-        readonly method: "push";
+        readonly type: 'callGlobal';
+        readonly global: 'uetq';
+        readonly method: 'push';
         readonly args: ["consent", "update", {
-            readonly ad_storage: "granted";
+            readonly ad_storage: 'granted';
         }];
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "uetq";
-        readonly method: "push";
+        readonly type: 'callGlobal';
+        readonly global: 'uetq';
+        readonly method: 'push';
         readonly args: ["consent", "update", {
-            readonly ad_storage: "denied";
+            readonly ad_storage: 'denied';
         }];
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface MicrosoftUetOptions {
     /**

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

@@ -130,44 +130,44 @@ declare global {
  * event before the external bundle loads.
  */
 export declare const redditPixelManifest: {
-    readonly vendor: "reddit-pixel";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'reddit-pixel';
+    readonly category: 'marketing';
     readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "rdt";
+        readonly type: 'defineStubFunction';
+        readonly name: 'rdt';
         readonly queue: {
-            readonly property: "callQueue";
+            readonly property: 'callQueue';
         };
-        readonly dispatchProperty: "sendEvent";
-        readonly queueFormat: "array";
+        readonly dispatchProperty: 'sendEvent';
+        readonly queueFormat: 'array';
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "callGlobal";
-        readonly global: "rdt";
+        readonly type: 'callGlobal';
+        readonly global: 'rdt';
         readonly args: ["init", "{{pixelId}}"];
     }, {
-        readonly type: "callGlobal";
-        readonly global: "rdt";
+        readonly type: 'callGlobal';
+        readonly global: 'rdt';
         readonly args: ["track", "PageVisit"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "rdt";
+        readonly type: 'callGlobal';
+        readonly global: 'rdt';
         readonly args: ["enableFirstPartyCookies"];
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "rdt";
+        readonly type: 'callGlobal';
+        readonly global: 'rdt';
         readonly args: ["disableFirstPartyCookies"];
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface RedditPixelOptions {
     /**

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

@@ -62,39 +62,39 @@ declare global {
  * `PAGE_VIEW` event before the vendor bundle loads.
  */
 export declare const snapchatPixelManifest: {
-    readonly vendor: "snapchat-pixel";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'snapchat-pixel';
+    readonly category: 'marketing';
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "snaptr";
+        readonly type: 'defineStubFunction';
+        readonly name: 'snaptr';
         readonly queue: {
-            readonly property: "queue";
+            readonly property: 'queue';
         };
-        readonly dispatchProperty: "handleRequest";
-        readonly queueFormat: "array";
+        readonly dispatchProperty: 'handleRequest';
+        readonly queueFormat: 'array';
         readonly aliases: ["_snaptr"];
         readonly selfReferences: ["push"];
         readonly properties: {
             readonly loaded: true;
-            readonly version: "1.0";
+            readonly version: '1.0';
         };
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "callGlobal";
-        readonly global: "snaptr";
+        readonly type: 'callGlobal';
+        readonly global: 'snaptr';
         readonly args: ["init", "{{pixelId}}"];
     }, {
-        readonly type: "callGlobal";
-        readonly global: "snaptr";
+        readonly type: 'callGlobal';
+        readonly global: 'snaptr';
         readonly args: ["track", "PAGE_VIEW"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface SnapchatPixelOptions {
     /**

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

@@ -29,53 +29,53 @@ declare global {
  * via `ttq.grantConsent()` / `ttq.revokeConsent()`.
  */
 export declare const tiktokPixelManifest: {
-    readonly vendor: "tiktok-pixel";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    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: 'TiktokAnalyticsObject';
+        readonly value: 'ttq';
     }, {
-        readonly type: "setGlobal";
-        readonly name: "ttq";
+        readonly type: 'setGlobal';
+        readonly name: 'ttq';
         readonly value: readonly [];
         readonly ifUndefined: true;
     }, {
-        readonly type: "defineQueueMethods";
-        readonly target: "ttq";
+        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: 'grantConsent';
     }, {
-        readonly type: "callGlobal";
-        readonly global: "ttq";
-        readonly method: "page";
+        readonly type: 'callGlobal';
+        readonly global: 'ttq';
+        readonly method: 'page';
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq";
+        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 type: 'callGlobal';
+        readonly global: 'ttq';
+        readonly method: 'grantConsent';
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "ttq";
-        readonly method: "grantConsent";
+        readonly type: 'callGlobal';
+        readonly global: 'ttq';
+        readonly method: 'grantConsent';
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "ttq";
-        readonly method: "revokeConsent";
+        readonly type: 'callGlobal';
+        readonly global: 'ttq';
+        readonly method: 'revokeConsent';
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface TikTokPixelOptions {
     /**

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

@@ -105,31 +105,31 @@ declare global {
  * No consent API — the script simply loads or doesn't based on consent.
  */
 export declare const xPixelManifest: {
-    readonly vendor: "x-pixel";
-    readonly category: "marketing";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'x-pixel';
+    readonly category: 'marketing';
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "twq";
+        readonly type: 'defineStubFunction';
+        readonly name: 'twq';
         readonly queue: {
-            readonly property: "queue";
+            readonly property: 'queue';
         };
-        readonly dispatchProperty: "exe";
+        readonly dispatchProperty: 'exe';
         readonly properties: {
-            readonly version: "1.1";
+            readonly version: '1.1';
         };
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "callGlobal";
-        readonly global: "twq";
+        readonly type: 'callGlobal';
+        readonly global: 'twq';
         readonly args: ["config", "{{pixelId}}"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptSrc}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptSrc}}';
         readonly async: true;
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface XPixelOptions {
     /**

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

@@ -0,0 +1,75 @@
+import type { Script } from 'c15t';
+import { type VendorManifest } from '../../types';
+declare global {
+    interface Window {
+        adobeDataLayer?: unknown[];
+        _satellite?: Record<string, unknown>;
+    }
+}
+/**
+ * Adobe Analytics vendor manifest.
+ *
+ * Loads the Adobe Experience Platform Data Collection Tags embed script for a
+ * specific property environment. Adobe does not provide a generic public
+ * loader; each customer copies their own environment URL from Data Collection,
+ * commonly hosted at `https://assets.adobedtm.com/.../launch-*.min.js`.
+ */
+export declare const adobeAnalyticsManifest: VendorManifest;
+export interface AdobeAnalyticsOptions {
+    /**
+     * Adobe Experience Platform Data Collection web property embed URL.
+     *
+     * This must be the full `https:` URL from your Adobe Tags environment embed
+     * code, commonly shaped like
+     * `https://assets.adobedtm.com/{org}/{property}/launch-{env}.min.js`.
+     * Self-hosted Launch/Tags embeds are supported as long as they use `https:`.
+     */
+    scriptUrl: string;
+    /**
+     * Load the Adobe Tags library asynchronously.
+     *
+     * Adobe recommends asynchronous deployment for most web properties. Set this
+     * to `false` only for legacy synchronous setups that require ordered blocking
+     * behavior.
+     * @default true
+     */
+    async?: boolean;
+    /**
+     * Seed the Adobe Client Data Layer queue before the Tags library loads.
+     *
+     * When enabled, c15t creates `window.adobeDataLayer = []` only when the
+     * global is still undefined. This matches Adobe Client Data Layer's default
+     * object name and is harmless for properties that do not use the extension.
+     * @default true
+     */
+    seedAdobeDataLayer?: boolean;
+}
+/**
+ * Creates an Adobe Analytics script.
+ *
+ * @see https://experienceleague.adobe.com/en/docs/experience-platform/tags/publish/environments/environments
+ * @see https://experienceleague.adobe.com/en/docs/experience-platform/tags/extensions/client/client-data-layer/overview
+ *
+ * @param options - The options for the Adobe Analytics script.
+ * @returns The Adobe Analytics script.
+ * @throws {Error} When `scriptUrl` is missing, empty, invalid, or not `https:`.
+ * Copy the full web property embed URL from Adobe Data Collection and pass it
+ * as `scriptUrl`.
+ *
+ * @remarks
+ * Adobe Analytics is commonly deployed through Adobe Experience Platform Data
+ * Collection Tags (formerly Launch). The loaded property may in turn load Adobe
+ * Analytics, Web SDK, or other extensions and rules, so configure those Adobe
+ * rules to respect your consent model too.
+ *
+ * @example
+ * ```ts
+ * import { adobeAnalytics } from '@c15t/scripts/adobe-analytics';
+ *
+ * adobeAnalytics({
+ *   scriptUrl:
+ *     'https://assets.adobedtm.com/YOUR_ORG/YOUR_PROPERTY/launch-production.min.js',
+ * });
+ * ```
+ */
+export declare function adobeAnalytics(options: AdobeAnalyticsOptions): Script;