@c15t/scripts 2.2.0 → 3.0.0-alpha.0

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

@@ -1,12 +1,12 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 export interface LinkedInInsightsConversionEvent {
     conversion_id: string | number;
     [key: string]: unknown;
 }
-type LinkedInInsightsFunction = {
+interface LinkedInInsightsFunction {
     (command: 'track', event: LinkedInInsightsConversionEvent): void;
     (command: string, ...args: unknown[]): void;
-};
+}
 declare global {
     interface Window {
         lintrk: LinkedInInsightsFunction & {
@@ -30,35 +30,35 @@ declare global {
 export declare const linkedinInsightsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'linkedin-insights';
     readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: false;
         readonly name: '_linkedin_partner_id';
+        readonly type: 'setGlobal';
         readonly value: '{{id}}';
-        readonly ifUndefined: false;
     }, {
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: '_linkedin_data_partner_ids';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'pushToQueue';
         readonly queue: '_linkedin_data_partner_ids';
+        readonly type: 'pushToQueue';
         readonly value: '{{id}}';
     }, {
-        readonly type: 'defineStubFunction';
+        readonly ifUndefined: true;
         readonly name: 'lintrk';
         readonly queue: {
             readonly property: 'q';
         };
         readonly queueFormat: 'array';
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptSrc}}';
         readonly async: true;
+        readonly src: '{{scriptSrc}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'linkedin-insights';
 };
 export interface LinkedInInsightsOptions {
     /**
@@ -88,5 +88,5 @@ export interface LinkedInInsightsOptions {
  *
  * @see {@link https://www.linkedin.com/help/lms/answer/a418880} Add the LinkedIn Insight Tag to your website
  */
-export declare function linkedinInsights({ id, scriptSrc, }: LinkedInInsightsOptions): Script;
+export declare const linkedinInsights: ({ id, scriptSrc, }: LinkedInInsightsOptions) => Script;
 export {};

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Represents the `contents` array object property.
  */
@@ -128,51 +128,51 @@ declare global {
 export declare const metaPixelManifest: {
     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 queue: {
-            readonly property: 'queue';
-        };
-        readonly dispatchProperty: 'callMethod';
-        readonly selfReferences: ["push"];
         readonly aliases: ["_fbq"];
+        readonly dispatchProperty: 'callMethod';
+        readonly ifUndefined: true;
+        readonly name: 'fbq';
         readonly properties: {
             readonly loaded: true;
             readonly version: '2.0';
         };
-        readonly ifUndefined: true;
+        readonly queue: {
+            readonly property: 'queue';
+        };
+        readonly selfReferences: ["push"];
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'callGlobal';
-        readonly global: 'fbq';
         readonly args: ["consent", "grant"];
-    }, {
-        readonly type: 'callGlobal';
         readonly global: 'fbq';
-        readonly args: ["init", "{{pixelId}}"];
-    }, {
         readonly type: 'callGlobal';
+    }, {
+        readonly args: ["init", "{{pixelId}}"];
         readonly global: 'fbq';
+        readonly type: 'callGlobal';
+    }, {
         readonly args: ["track", "PageView"];
+        readonly global: 'fbq';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptSrc}}';
         readonly async: true;
-    }];
-    readonly onConsentGranted: [{
-        readonly type: 'callGlobal';
-        readonly global: 'fbq';
-        readonly args: ["consent", "grant"];
+        readonly src: '{{scriptSrc}}';
+        readonly type: 'loadScript';
     }];
     readonly onConsentDenied: [{
+        readonly args: ["consent", "revoke"];
+        readonly global: 'fbq';
         readonly type: 'callGlobal';
+    }];
+    readonly onConsentGranted: [{
+        readonly args: ["consent", "grant"];
         readonly global: 'fbq';
-        readonly args: ["consent", "revoke"];
+        readonly type: 'callGlobal';
     }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'meta-pixel';
 };
 export interface MetaPixelOptions {
     /**
@@ -216,7 +216,7 @@ export interface MetaPixelOptions {
  *
  * @see {@link https://developers.facebook.com/docs/meta-pixel/get-started} Meta Pixel documentation
  */
-export declare function metaPixel({ pixelId, initOptions, trackPageView, dataProcessingOptions, scriptSrc, }: MetaPixelOptions): Script;
+export declare const metaPixel: ({ pixelId, initOptions, trackPageView, dataProcessingOptions, scriptSrc, }: MetaPixelOptions) => Script;
 /**
  * Tracks a Meta Pixel standard event.
  *

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         uetq: unknown[] | undefined;
@@ -13,68 +13,68 @@ declare global {
 export declare const microsoftUetManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'microsoft-uet';
-    readonly category: 'marketing';
+    readonly afterLoad: [{
+        readonly args: [{
+            readonly enableAutoSpaTracking: true;
+            readonly ti: '{{id}}';
+        }];
+        readonly assignTo: 'uetq';
+        readonly constructor: 'UET';
+        readonly copyAssignedValueToArgProperty: 'q';
+        readonly type: 'constructGlobal';
+    }, {
+        readonly args: ["pageLoad"];
+        readonly global: 'uetq';
+        readonly method: 'push';
+        readonly type: 'callGlobal';
+    }];
     readonly alwaysLoad: true;
-    readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'uetq';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }];
-    readonly onBeforeLoadGranted: [{
-        readonly type: 'callGlobal';
+    readonly category: 'marketing';
+    readonly install: [{
+        readonly async: true;
+        readonly src: '{{scriptSrc}}';
+        readonly type: 'loadScript';
+    }];
+    readonly onBeforeLoadDenied: [{
+        readonly args: ["consent", "default", {
+            readonly ad_storage: 'denied';
+        }];
         readonly global: 'uetq';
         readonly method: 'push';
+        readonly type: 'callGlobal';
+    }];
+    readonly onBeforeLoadGranted: [{
         readonly args: ["consent", "default", {
             readonly ad_storage: 'granted';
         }];
-    }];
-    readonly onBeforeLoadDenied: [{
-        readonly type: 'callGlobal';
         readonly global: 'uetq';
         readonly method: 'push';
-        readonly args: ["consent", "default", {
-            readonly ad_storage: 'denied';
-        }];
-    }];
-    readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptSrc}}';
-        readonly async: true;
+        readonly type: 'callGlobal';
     }];
-    readonly afterLoad: [{
-        readonly type: 'constructGlobal';
-        readonly constructor: 'UET';
-        readonly assignTo: 'uetq';
-        readonly args: [{
-            readonly ti: '{{id}}';
-            readonly enableAutoSpaTracking: true;
+    readonly onConsentDenied: [{
+        readonly args: ["consent", "update", {
+            readonly ad_storage: 'denied';
         }];
-        readonly copyAssignedValueToArgProperty: 'q';
-    }, {
-        readonly type: 'callGlobal';
         readonly global: 'uetq';
         readonly method: 'push';
-        readonly args: ["pageLoad"];
+        readonly type: 'callGlobal';
     }];
     readonly onConsentGranted: [{
-        readonly type: 'callGlobal';
-        readonly global: 'uetq';
-        readonly method: 'push';
         readonly args: ["consent", "update", {
             readonly ad_storage: 'granted';
         }];
-    }];
-    readonly onConsentDenied: [{
-        readonly type: 'callGlobal';
         readonly global: 'uetq';
         readonly method: 'push';
-        readonly args: ["consent", "update", {
-            readonly ad_storage: 'denied';
-        }];
+        readonly type: 'callGlobal';
     }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'microsoft-uet';
 };
 export interface MicrosoftUetOptions {
     /**
@@ -102,4 +102,4 @@ export interface MicrosoftUetOptions {
  *
  * @see https://learn.microsoft.com/en-us/advertising/guides/universal-event-tracking?view=bingads-13
  */
-export declare function microsoftUet({ id, scriptSrc }: MicrosoftUetOptions): Script;
+export declare const microsoftUet: ({ id, scriptSrc, }: MicrosoftUetOptions) => Script;

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

@@ -0,0 +1,211 @@
+import type { Script } from '@c15t/core';
+/** User matching fields accepted by OpenAI. Hash identifiers before passing them. */
+export interface OpenAIPixelUser {
+    /** SHA-256 of the trimmed, lowercase email address. */
+    email_sha256?: string;
+    /** SHA-256 of the normalized phone number, including its country code. */
+    phone_number_sha256?: string;
+    /** SHA-256 of the trimmed external ID, preserving case. */
+    external_id_sha256?: string;
+    /** SHA-256 of the lowercase first name without whitespace or ASCII punctuation. */
+    first_name_sha256?: string;
+    /** SHA-256 of the lowercase last name without whitespace or ASCII punctuation. */
+    last_name_sha256?: string;
+    /** Two-letter ISO 3166-1 country code. */
+    country?: string;
+    /** City name, up to 128 characters. */
+    city?: string;
+    /** State, province, or region, up to 128 characters. */
+    region?: string;
+    /** Postal or ZIP code, up to 32 characters. */
+    postal_code?: string;
+}
+/** Documented options for `oaiq('init', ...)`, including subsequent user updates. */
+export interface OpenAIPixelInitOptions {
+    /** Required on first initialization; include for updates with multiple pixels. */
+    pixelId?: string;
+    /** Log SDK activity to the browser console. */
+    debug?: boolean;
+    /** Complete user matching payload. Raw identifiers must not be sent. */
+    user?: OpenAIPixelUser;
+}
+/** An item attached to a browser conversion event. */
+export interface OpenAIPixelContent {
+    id?: string;
+    name?: string;
+    content_type?: string;
+    /** Integer item quantity. */
+    quantity?: number;
+    /** Integer amount in the currency's minor unit. */
+    amount?: number;
+    /** ISO 4217 code; may inherit the event currency. */
+    currency?: string;
+}
+/** Event-level amounts require an ISO 4217 currency code. */
+type OpenAIPixelValue = {
+    amount: number;
+    currency: string;
+} | {
+    amount?: never;
+    currency?: string;
+};
+/** Payload for page views and commerce events. */
+export type OpenAIPixelContentsData = OpenAIPixelValue & {
+    type: 'contents';
+    contents?: OpenAIPixelContent[];
+};
+/** Payload for leads, registrations, and appointments. */
+export type OpenAIPixelCustomerActionData = OpenAIPixelValue & {
+    type: 'customer_action';
+};
+/** Payload for subscriptions and trials. */
+export type OpenAIPixelPlanData = OpenAIPixelValue & {
+    type: 'plan_enrollment';
+    plan_id?: string;
+    contents?: OpenAIPixelContent[];
+};
+/** Payload for a custom conversion. */
+export type OpenAIPixelCustomData = OpenAIPixelValue & {
+    type: 'custom';
+    plan_id?: string;
+    contents?: OpenAIPixelContent[];
+};
+/** Browser event names and their required payload shapes. */
+export interface OpenAIPixelEventData {
+    appointment_scheduled: OpenAIPixelCustomerActionData;
+    checkout_started: OpenAIPixelContentsData;
+    contents_viewed: OpenAIPixelContentsData;
+    items_added: OpenAIPixelContentsData;
+    lead_created: OpenAIPixelCustomerActionData;
+    order_created: OpenAIPixelContentsData;
+    page_viewed: OpenAIPixelContentsData;
+    registration_completed: OpenAIPixelCustomerActionData;
+    subscription_created: OpenAIPixelPlanData;
+    trial_started: OpenAIPixelPlanData;
+}
+/** Options passed separately from event data to the Measurement Pixel. */
+export interface OpenAIPixelEventOptions {
+    /** Reuse the same ID for browser/server event deduplication. */
+    event_id?: string;
+    /** Opt this event out of future user-level personalization. */
+    opt_out?: boolean;
+}
+/** Custom events require a name in addition to their event data. */
+export interface OpenAIPixelCustomEventOptions extends OpenAIPixelEventOptions {
+    /** A 1–64 character name using letters, numbers, underscores, or dashes. */
+    custom_event_name: string;
+}
+/** Arguments accepted by the event helper and the SDK's measure commands. */
+export type OpenAIPixelEventArgs = {
+    [EventName in keyof OpenAIPixelEventData]: [
+        eventName: EventName,
+        data: OpenAIPixelEventData[EventName],
+        options?: OpenAIPixelEventOptions
+    ];
+}[keyof OpenAIPixelEventData] | [
+    eventName: 'custom',
+    data: OpenAIPixelCustomData,
+    options: OpenAIPixelCustomEventOptions
+];
+/** The documented OpenAI browser command API and its pre-load queue. */
+export interface OpenAIPixelFunction {
+    (command: 'consent', granted: boolean): void;
+    (command: 'init', options: OpenAIPixelInitOptions): void;
+    (command: 'measure', ...args: OpenAIPixelEventArgs): void;
+    (command: 'measureSingle', pixelId: string, ...args: OpenAIPixelEventArgs): void;
+    /** Commands queued before the SDK replaces the stub. */
+    q?: IArguments[];
+}
+declare global {
+    interface Window {
+        oaiq?: OpenAIPixelFunction;
+    }
+}
+/** Options for the ChatGPT Ads Measurement Pixel. */
+export interface OpenAIPixelOptions extends OpenAIPixelInitOptions {
+    /** Pixel ID from the conversions tab in OpenAI Ads Manager. */
+    pixelId: string;
+    /** Log SDK activity in the browser console. @default false */
+    debug?: boolean;
+    /** Override the Measurement Pixel SDK URL. */
+    scriptSrc?: string;
+}
+/**
+ * ChatGPT Ads Measurement Pixel manifest.
+ *
+ * Loads after marketing consent. Denies measurement before initialization,
+ * then applies the current consent state before the SDK executes.
+ *
+ * @see https://developers.openai.com/ads/measurement-pixel
+ */
+export declare const openaiPixelManifest: {
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly bootstrap: [{
+        readonly ifUndefined: true;
+        readonly name: 'oaiq';
+        readonly queue: {
+            readonly property: 'q';
+        };
+        readonly type: 'defineStubFunction';
+    }, {
+        readonly args: ["consent", false];
+        readonly global: 'oaiq';
+        readonly type: 'callGlobal';
+    }];
+    readonly category: 'marketing';
+    readonly install: [{
+        readonly args: ["init", "{{initOptions}}"];
+        readonly global: 'oaiq';
+        readonly type: 'callGlobal';
+    }, {
+        readonly async: true;
+        readonly src: '{{scriptSrc}}';
+        readonly type: 'loadScript';
+    }];
+    readonly onBeforeLoadGranted: [{
+        readonly args: ["consent", true];
+        readonly global: 'oaiq';
+        readonly type: 'callGlobal';
+    }];
+    readonly onConsentDenied: [{
+        readonly args: ["consent", false];
+        readonly global: 'oaiq';
+        readonly type: 'callGlobal';
+    }];
+    readonly onConsentGranted: [{
+        readonly args: ["consent", true];
+        readonly global: 'oaiq';
+        readonly type: 'callGlobal';
+    }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'openai-pixel';
+};
+/**
+ * Creates a consent-aware ChatGPT Ads Measurement Pixel script.
+ *
+ * @param options - Pixel ID, debug logging, and optional SDK URL.
+ * @returns A script gated on marketing consent, with SDK consent updates.
+ * @example
+ * ```ts
+ * openaiPixel({ pixelId: 'YOUR_PIXEL_ID', debug: true });
+ * ```
+ */
+export declare const openaiPixel: ({ pixelId, debug, user, scriptSrc, }: OpenAIPixelOptions) => Script;
+/**
+ * Sends a conversion to every initialized OpenAI pixel.
+ *
+ * Calls before the queue exists are dropped. Once loaded, the SDK applies
+ * c15t's consent signal. Use `window.oaiq('measureSingle', ...)` to target one pixel.
+ *
+ * @param args - Event name, matching data, and event options.
+ * @returns Nothing.
+ * @example
+ * ```ts
+ * openaiPixelEvent('order_created', {
+ *   type: 'contents', amount: 2599, currency: 'USD',
+ * }, { event_id: 'order_123' });
+ * ```
+ */
+export declare const openaiPixelEvent: (...args: OpenAIPixelEventArgs) => void;
+export {};

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Reddit Pixel standard conversion event names.
  *
@@ -68,7 +68,7 @@ export interface RedditPixelInitOptions {
     /** Integration partner version. */
     partner_version?: string;
     /** Source integration name reported to Reddit. */
-    integration?: 'reddit' | 'gtm' | (string & {});
+    integration?: 'reddit' | 'gtm' | (string & Record<never, never>);
     /** Enable Reddit Pixel debug logging. */
     debug?: boolean;
     /**
@@ -92,13 +92,13 @@ export interface RedditPixelEventMetadata {
     currency?: string;
     transactionId?: string;
     customEventName?: string;
-    products?: string | Array<{
+    products?: string | {
         id?: string | number;
         name?: string;
         category?: string;
         quantity?: number | string;
         itemPrice?: number | string;
-    }>;
+    }[];
     /**
      * Conversion ID used to deduplicate Pixel events against Conversions API
      * events.
@@ -108,13 +108,12 @@ export interface RedditPixelEventMetadata {
     conversionId?: string;
     [key: string]: unknown;
 }
-type RedditPixelFunction = {
+interface RedditPixelFunction {
     (command: 'init', pixelId: string, options?: RedditPixelInitOptions): void;
-    (command: 'enableFirstPartyCookies'): void;
-    (command: 'disableFirstPartyCookies'): void;
-    (command: 'track', eventName: RedditPixelEventName | (string & {}), properties?: RedditPixelEventMetadata): void;
+    (command: 'enableFirstPartyCookies' | 'disableFirstPartyCookies'): void;
+    (command: 'track', eventName: RedditPixelEventName | (string & Record<never, never>), properties?: RedditPixelEventMetadata): void;
     (command: string, ...args: unknown[]): void;
-};
+}
 declare global {
     interface Window {
         rdt?: RedditPixelFunction & {
@@ -132,42 +131,42 @@ declare global {
 export declare const redditPixelManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'reddit-pixel';
-    readonly category: 'marketing';
-    readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: 'defineStubFunction';
+        readonly dispatchProperty: 'sendEvent';
+        readonly ifUndefined: true;
         readonly name: 'rdt';
         readonly queue: {
             readonly property: 'callQueue';
         };
-        readonly dispatchProperty: 'sendEvent';
         readonly queueFormat: 'array';
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'marketing';
     readonly install: [{
-        readonly type: 'callGlobal';
-        readonly global: 'rdt';
         readonly args: ["init", "{{pixelId}}"];
-    }, {
-        readonly type: 'callGlobal';
         readonly global: 'rdt';
+        readonly type: 'callGlobal';
+    }, {
         readonly args: ["track", "PageVisit"];
+        readonly global: 'rdt';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
-    }];
-    readonly onConsentGranted: [{
-        readonly type: 'callGlobal';
-        readonly global: 'rdt';
-        readonly args: ["enableFirstPartyCookies"];
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
     readonly onConsentDenied: [{
+        readonly args: ["disableFirstPartyCookies"];
+        readonly global: 'rdt';
         readonly type: 'callGlobal';
+    }];
+    readonly onConsentGranted: [{
+        readonly args: ["enableFirstPartyCookies"];
         readonly global: 'rdt';
-        readonly args: ["disableFirstPartyCookies"];
+        readonly type: 'callGlobal';
     }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'reddit-pixel';
 };
 export interface RedditPixelOptions {
     /**
@@ -199,7 +198,7 @@ export interface RedditPixelOptions {
  * @param options - The options for the Reddit Pixel script.
  * @returns The Reddit Pixel script configuration.
  */
-export declare function redditPixel({ pixelId, trackPageVisit, initOptions, disableFirstPartyCookies, scriptUrl, }: RedditPixelOptions): Script;
+export declare const redditPixel: ({ pixelId, trackPageVisit, initOptions, disableFirstPartyCookies, scriptUrl, }: RedditPixelOptions) => Script;
 /**
  * Tracks a Reddit Pixel event.
  *
@@ -207,5 +206,5 @@ export declare function redditPixel({ pixelId, trackPageVisit, initOptions, disa
  * @param metadata - Optional event metadata, including `conversionId` for
  * Pixel plus Conversions API deduplication.
  */
-export declare const redditPixelEvent: (eventName: RedditPixelEventName | (string & {}), metadata?: RedditPixelEventMetadata) => void;
+export declare const redditPixelEvent: (eventName: RedditPixelEventName | (string & Record<never, never>), metadata?: RedditPixelEventMetadata) => void;
 export {};