@c15t/scripts 2.0.0-rc.1 → 2.0.0

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;

package/{dist → dist-types}/meta-pixel.d.ts

@@ -83,27 +83,75 @@ declare global {
         _fbq: Window['fbq'];
     }
 }
+/**
+ * Meta Pixel vendor manifest.
+ *
+ * The Meta Pixel uses structured bootstrap steps to define the standard `fbq`
+ * stub and provides a consent API via `fbq('consent', 'grant'|'revoke')`.
+ */
+export declare const metaPixelManifest: {
+    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 properties: {
+            readonly loaded: true;
+            readonly version: "2.0";
+        };
+        readonly ifUndefined: true;
+    }];
+    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 global: "fbq";
+        readonly args: ["track", "PageView"];
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["consent", "grant"];
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "fbq";
+        readonly args: ["consent", "revoke"];
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
 export interface MetaPixelOptions {
     /**
      * Your Meta Pixel ID
      * @example `123456789012345`
      */
     pixelId: string;
-    /**
-     * Override or extend the default script values.
-     *
-     * Default values:
-     * - `id`: 'meta-pixel'
-     * - `src`: `https://connect.facebook.net/en_US/fbevents.js`
-     * - `category`: 'marketing'
-     */
-    script?: Partial<Script>;
+    /** Meta Pixel loader URL. */
+    scriptSrc?: string;
 }
 /**
- * Creates a Meta Pixel script with inline JavaScript code.
+ * Creates a Meta Pixel script.
  *
- * This script uses textContent to inject the Meta Pixel tracking code directly
- * into the page, which is the recommended approach for Meta Pixel implementation.
+ * The manifest defines a structured `fbq` stub plus the external loader URL,
+ * avoiding raw inline vendor snippets in the manifest payload.
  *
  * @param options - The options for the Meta Pixel script
  * @returns The Meta Pixel script configuration
@@ -117,7 +165,7 @@ export interface MetaPixelOptions {
  *
  * @see {@link https://developers.facebook.com/docs/meta-pixel/get-started} Meta Pixel documentation
  */
-export declare function metaPixel({ pixelId, script }: MetaPixelOptions): Script;
+export declare function metaPixel({ pixelId, scriptSrc }: MetaPixelOptions): Script;
 /**
  * Meta Pixel Event
  * This is a wrapper around the `fbq` function that the Meta Pixel script uses.
@@ -135,4 +183,3 @@ export declare function metaPixel({ pixelId, script }: MetaPixelOptions): Script
  */
 export declare const metaPixelEvent: <TEventName extends StandardEventName>(eventName: TEventName, params?: StandardEventParams[TEventName], eventId?: string) => void;
 export {};
-//# sourceMappingURL=meta-pixel.d.ts.map

package/dist-types/microsoft-uet.d.ts

@@ -0,0 +1,94 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        uetq: unknown[] | undefined;
+    }
+}
+/**
+ * Microsoft UET vendor manifest.
+ *
+ * Uses structured startup steps and manages consent via the UET push API:
+ * `window.uetq.push('consent', 'default'|'update', { ad_storage: 'granted'|'denied' })`
+ */
+export declare const microsoftUetManifest: {
+    readonly vendor: "microsoft-uet";
+    readonly category: "marketing";
+    readonly persistAfterConsentRevoked: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "uetq";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }];
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly afterLoad: [{
+        readonly type: "constructGlobal";
+        readonly constructor: "UET";
+        readonly assignTo: "uetq";
+        readonly args: [{
+            readonly ti: "{{id}}";
+            readonly enableAutoSpaTracking: true;
+        }];
+        readonly copyAssignedValueToArgProperty: "q";
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["pageLoad"];
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "uetq";
+        readonly method: "push";
+        readonly args: ["consent", "default", {
+            readonly ad_storage: "granted";
+        }];
+    }];
+    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 kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+export interface MicrosoftUetOptions {
+    /**
+     * Your Microsoft UET ID
+     * @example `123456789012345`
+     */
+    id: string;
+    /** Microsoft UET loader URL. */
+    scriptSrc?: string;
+}
+/**
+ * Microsoft UET Script
+ * This script is persistent after consent is revoked because it has built-in functionality to opt into and out of tracking based on consent, which allows us to not need to load the script again when consent is revoked.
+ *
+ * @param options - The options for the Microsoft UET script
+ * @returns The Microsoft UET script configuration
+ *
+ * @example
+ * ```ts
+ * const microsoftUetScript = microsoftUet({
+ *   id: '123456789012345',
+ * });
+ * ```
+ *
+ * @see https://learn.microsoft.com/en-us/advertising/guides/universal-event-tracking?view=bingads-13
+ */
+export declare function microsoftUet({ id, scriptSrc }: MicrosoftUetOptions): Script;

package/dist-types/posthog.d.ts

@@ -0,0 +1,112 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        posthog: {
+            init: (token: string, options: {
+                api_host: string;
+                ui_host?: string;
+                autocapture?: boolean;
+                [key: string]: unknown;
+            }) => void;
+            opt_in_capturing: () => void;
+            opt_out_capturing: () => void;
+            get_explicit_consent_status: () => string;
+        };
+    }
+}
+/**
+ * PostHog vendor manifest.
+ *
+ * PostHog manages its own consent internally via opt_in/opt_out capturing.
+ * The script always loads, and consent is toggled via the PostHog API.
+ */
+export declare const posthogManifest: {
+    readonly vendor: "posthog";
+    readonly category: "measurement";
+    readonly alwaysLoad: true;
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "posthog";
+        readonly value: {};
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineGlobalMethods";
+        readonly target: "posthog";
+        readonly methods: [{
+            readonly name: "init";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "opt_in_capturing";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "opt_out_capturing";
+            readonly behavior: "noop";
+        }, {
+            readonly name: "get_explicit_consent_status";
+            readonly behavior: "return";
+            readonly value: "pending";
+        }];
+    }];
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly async: true;
+        readonly attributes: {
+            readonly crossorigin: "anonymous";
+            readonly 'data-api-host': "{{apiHost}}";
+            readonly 'data-ui-host': "{{apiHost}}";
+        };
+    }];
+    readonly afterLoad: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "init";
+        readonly args: ["{{id}}", "{{initOptions}}"];
+    }];
+    readonly onLoadGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_in_capturing";
+    }];
+    readonly onLoadDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_out_capturing";
+    }];
+    readonly onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_in_capturing";
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "posthog";
+        readonly method: "opt_out_capturing";
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+export interface PosthogConsentOptions {
+    /**
+     * Your posthog id, begins with 'phc_'.
+     */
+    id: string;
+    /**
+     * Your posthog api host.
+     * @default 'https://eu.i.posthog.com'
+     */
+    apiHost?: string;
+    /** The PostHog array loader URL. */
+    scriptUrl?: string;
+    /** PostHog init options passed to `posthog.init(...)`. */
+    initOptions?: Record<string, unknown>;
+}
+/**
+ * Loads the PostHog script and initializes it with the given options.
+ * This uses posthog.opt_in_capturing() to opt in to capturing. And posthog.opt_out_capturing() to opt out of capturing.
+ * @see https://posthog.com/docs/libraries/js#opt-in-capturing
+ *
+ * @param options - Optional configuration for the PostHog consent script
+ * @returns The Posthog script
+ */
+export declare function posthog(options: PosthogConsentOptions): Script;

package/dist-types/resolve.d.ts

@@ -0,0 +1,9 @@
+import type { Script } from 'c15t';
+import type { VendorManifest } from './types';
+/**
+ * Compiles a `VendorManifest` + config into a `Script` object.
+ *
+ * This compatibility wrapper preserves the existing public resolver API while
+ * delegating to the new compile and runtime conversion phases internally.
+ */
+export declare function resolveManifest(manifest: VendorManifest, config?: Record<string, unknown>): Script;

package/dist-types/tiktok-pixel.d.ts

@@ -0,0 +1,91 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        ttq: {
+            grantConsent: () => void;
+            revokeConsent: () => void;
+            page: () => void;
+        };
+    }
+}
+/**
+ * TikTok Pixel vendor manifest.
+ *
+ * Uses structured bootstrap steps and provides a consent API
+ * via `ttq.grantConsent()` / `ttq.revokeConsent()`.
+ */
+export declare const tiktokPixelManifest: {
+    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: "ttq";
+        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 install: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "grantConsent";
+    }, {
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "page";
+    }, {
+        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 onConsentGranted: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "grantConsent";
+    }];
+    readonly onConsentDenied: [{
+        readonly type: "callGlobal";
+        readonly global: "ttq";
+        readonly method: "revokeConsent";
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+export interface TikTokPixelOptions {
+    /**
+     * Your TikTok Pixel ID
+     * @example `123456789012345`
+     */
+    pixelId: string;
+    /** TikTok Pixel loader base URL. */
+    scriptSrc?: string;
+}
+/**
+ * Creates a Tiktok Pixel script.
+ * This script is persistent after consent is revoked because it has built-in functionality to opt into and out of tracking based on consent, which allows us to not need to load the script again when consent is revoked.
+ *
+ * @param options - The options for the TikTok Pixel script
+ * @returns The TikTok Pixel script configuration
+ *
+ * @example
+ * ```ts
+ * const tiktokPixelScript = tiktokPixel({
+ *   pixelId: '123456789012345',
+ * });
+ * ```
+ *
+ * @see {@link https://ads.tiktok.com/help/article/tiktok-pixel} TikTok Pixel documentation
+ */
+export declare function tiktokPixel({ pixelId, scriptSrc, }: TikTokPixelOptions): Script;