@c15t/scripts 2.0.1 → 2.1.0

package/dist/meta-pixel.cjs

@@ -1,129 +0,0 @@
-"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__, {
-    metaPixelManifest: ()=>metaPixelManifest,
-    metaPixel: ()=>metaPixel,
-    metaPixelEvent: ()=>metaPixelEvent
-});
-const external_resolve_cjs_namespaceObject = require("./resolve.cjs");
-const external_types_cjs_namespaceObject = require("./types.cjs");
-const metaPixelManifest = {
-    ...external_types_cjs_namespaceObject.vendorManifestContract,
-    vendor: 'meta-pixel',
-    category: 'marketing',
-    persistAfterConsentRevoked: true,
-    bootstrap: [
-        {
-            type: 'defineStubFunction',
-            name: 'fbq',
-            queue: {
-                property: 'queue'
-            },
-            dispatchProperty: 'callMethod',
-            selfReferences: [
-                'push'
-            ],
-            aliases: [
-                '_fbq'
-            ],
-            properties: {
-                loaded: true,
-                version: '2.0'
-            },
-            ifUndefined: true
-        }
-    ],
-    install: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'grant'
-            ]
-        },
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'init',
-                '{{pixelId}}'
-            ]
-        },
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'track',
-                'PageView'
-            ]
-        },
-        {
-            type: 'loadScript',
-            src: "{{scriptSrc}}",
-            async: true
-        }
-    ],
-    onConsentGranted: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'grant'
-            ]
-        }
-    ],
-    onConsentDenied: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'revoke'
-            ]
-        }
-    ]
-};
-function metaPixel({ pixelId, scriptSrc }) {
-    const resolved = (0, external_resolve_cjs_namespaceObject.resolveManifest)(metaPixelManifest, {
-        pixelId,
-        scriptSrc: scriptSrc ?? 'https://connect.facebook.net/en_US/fbevents.js'
-    });
-    return resolved;
-}
-const metaPixelEvent = (eventName, params, eventId)=>window.fbq('track', eventName, params, eventId);
-exports.metaPixel = __webpack_exports__.metaPixel;
-exports.metaPixelEvent = __webpack_exports__.metaPixelEvent;
-exports.metaPixelManifest = __webpack_exports__.metaPixelManifest;
-for(var __rspack_i in __webpack_exports__)if (-1 === [
-    "metaPixel",
-    "metaPixelEvent",
-    "metaPixelManifest"
-].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});

package/dist/meta-pixel.js

@@ -1,89 +0,0 @@
-import { resolveManifest } from "./resolve.js";
-import { vendorManifestContract } from "./types.js";
-const metaPixelManifest = {
-    ...vendorManifestContract,
-    vendor: 'meta-pixel',
-    category: 'marketing',
-    persistAfterConsentRevoked: true,
-    bootstrap: [
-        {
-            type: 'defineStubFunction',
-            name: 'fbq',
-            queue: {
-                property: 'queue'
-            },
-            dispatchProperty: 'callMethod',
-            selfReferences: [
-                'push'
-            ],
-            aliases: [
-                '_fbq'
-            ],
-            properties: {
-                loaded: true,
-                version: '2.0'
-            },
-            ifUndefined: true
-        }
-    ],
-    install: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'grant'
-            ]
-        },
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'init',
-                '{{pixelId}}'
-            ]
-        },
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'track',
-                'PageView'
-            ]
-        },
-        {
-            type: 'loadScript',
-            src: "{{scriptSrc}}",
-            async: true
-        }
-    ],
-    onConsentGranted: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'grant'
-            ]
-        }
-    ],
-    onConsentDenied: [
-        {
-            type: 'callGlobal',
-            global: 'fbq',
-            args: [
-                'consent',
-                'revoke'
-            ]
-        }
-    ]
-};
-function metaPixel({ pixelId, scriptSrc }) {
-    const resolved = resolveManifest(metaPixelManifest, {
-        pixelId,
-        scriptSrc: scriptSrc ?? 'https://connect.facebook.net/en_US/fbevents.js'
-    });
-    return resolved;
-}
-const metaPixelEvent = (eventName, params, eventId)=>window.fbq('track', eventName, params, eventId);
-export { metaPixel, metaPixelEvent, metaPixelManifest };

package/dist/posthog.js

@@ -1,100 +0,0 @@
-import { resolveManifest } from "./resolve.js";
-import { vendorManifestContract } from "./types.js";
-const posthogManifest = {
-    ...vendorManifestContract,
-    vendor: 'posthog',
-    category: 'measurement',
-    alwaysLoad: true,
-    bootstrap: [
-        {
-            type: 'setGlobal',
-            name: 'posthog',
-            value: {},
-            ifUndefined: true
-        },
-        {
-            type: 'defineGlobalMethods',
-            target: 'posthog',
-            methods: [
-                {
-                    name: 'init',
-                    behavior: 'noop'
-                },
-                {
-                    name: 'opt_in_capturing',
-                    behavior: 'noop'
-                },
-                {
-                    name: 'opt_out_capturing',
-                    behavior: 'noop'
-                },
-                {
-                    name: 'get_explicit_consent_status',
-                    behavior: 'return',
-                    value: 'pending'
-                }
-            ]
-        }
-    ],
-    install: [
-        {
-            type: 'loadScript',
-            src: "{{scriptUrl}}",
-            async: true,
-            attributes: {
-                crossorigin: 'anonymous',
-                'data-api-host': '{{apiHost}}',
-                'data-ui-host': '{{apiHost}}'
-            }
-        }
-    ],
-    afterLoad: [
-        {
-            type: 'callGlobal',
-            global: 'posthog',
-            method: 'init',
-            args: [
-                '{{id}}',
-                '{{initOptions}}'
-            ]
-        }
-    ],
-    onLoadGranted: [
-        {
-            type: 'callGlobal',
-            global: 'posthog',
-            method: 'opt_in_capturing'
-        }
-    ],
-    onLoadDenied: [
-        {
-            type: 'callGlobal',
-            global: 'posthog',
-            method: 'opt_out_capturing'
-        }
-    ],
-    onConsentGranted: [
-        {
-            type: 'callGlobal',
-            global: 'posthog',
-            method: 'opt_in_capturing'
-        }
-    ],
-    onConsentDenied: [
-        {
-            type: 'callGlobal',
-            global: 'posthog',
-            method: 'opt_out_capturing'
-        }
-    ]
-};
-function posthog(options) {
-    const resolved = resolveManifest(posthogManifest, {
-        id: options.id,
-        apiHost: options.apiHost ?? 'https://eu.i.posthog.com',
-        scriptUrl: options.scriptUrl ?? 'https://eu-assets.i.posthog.com/static/array.js',
-        initOptions: options.initOptions ?? {}
-    });
-    return resolved;
-}
-export { posthog, posthogManifest };

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

@@ -1,185 +0,0 @@
-import type { Script } from 'c15t';
-/**
- * Represents the `contents` array object property.
- */
-export interface FbqContent {
-    id: string | number;
-    quantity: number;
-    [key: string]: unknown;
-}
-/**
- * Base interface for all possible event parameters.
- * All properties are optional here; specific event types will make them required.
- */
-export interface FbqBaseEventParams {
-    content_category?: string;
-    content_ids?: (string | number)[];
-    content_name?: string;
-    content_type?: 'product' | 'product_group';
-    contents?: FbqContent[];
-    currency?: string;
-    num_items?: number;
-    predicted_ltv?: number;
-    search_string?: string;
-    status?: boolean;
-    value?: number;
-}
-type AddPaymentInfoParams = Pick<FbqBaseEventParams, 'content_ids' | 'contents' | 'currency' | 'value'>;
-type AddToCartParams = Pick<FbqBaseEventParams, 'content_ids' | 'content_type' | 'contents' | 'currency' | 'value'>;
-type AddToWishlistParams = Pick<FbqBaseEventParams, 'content_ids' | 'contents' | 'currency' | 'value'>;
-type CompleteRegistrationParams = Pick<FbqBaseEventParams, 'currency' | 'value' | 'status'>;
-type InitiateCheckoutParams = Pick<FbqBaseEventParams, 'content_ids' | 'contents' | 'currency' | 'num_items' | 'value'>;
-type LeadParams = Pick<FbqBaseEventParams, 'currency' | 'value'>;
-type SearchParams = Pick<FbqBaseEventParams, 'content_ids' | 'content_type' | 'contents' | 'currency' | 'search_string' | 'value'>;
-type StartTrialParams = Pick<FbqBaseEventParams, 'currency' | 'predicted_ltv' | 'value'>;
-type SubscribeParams = Pick<FbqBaseEventParams, 'currency' | 'predicted_ltv' | 'value'>;
-type ViewContentParams = Pick<FbqBaseEventParams, 'content_ids' | 'content_type' | 'contents' | 'currency' | 'value'>;
-/**
- * The 'Purchase' event has required properties.
- * We use TypeScript's utility types to enforce this.
- */
-type PurchaseParams = Pick<FbqBaseEventParams, 'content_ids' | 'content_type' | 'contents' | 'num_items'> & Required<Pick<FbqBaseEventParams, 'currency' | 'value'>>;
-/**
- * Events with no specific properties listed can accept any of the base parameters.
- */
-type ContactParams = FbqBaseEventParams;
-type CustomizeProductParams = FbqBaseEventParams;
-type DonateParams = FbqBaseEventParams;
-type FindLocationParams = FbqBaseEventParams;
-type ScheduleParams = FbqBaseEventParams;
-type SubmitApplicationParams = FbqBaseEventParams;
-/**
- * A mapping of Standard Event names to their corresponding parameter types.
- * This is the core of our type-safety mechanism.
- */
-export interface StandardEventParams {
-    AddPaymentInfo: AddPaymentInfoParams;
-    AddToCart: AddToCartParams;
-    AddToWishlist: AddToWishlistParams;
-    CompleteRegistration: CompleteRegistrationParams;
-    Contact: ContactParams;
-    CustomizeProduct: CustomizeProductParams;
-    Donate: DonateParams;
-    FindLocation: FindLocationParams;
-    InitiateCheckout: InitiateCheckoutParams;
-    Lead: LeadParams;
-    Purchase: PurchaseParams;
-    Schedule: ScheduleParams;
-    Search: SearchParams;
-    StartTrial: StartTrialParams;
-    SubmitApplication: SubmitApplicationParams;
-    Subscribe: SubscribeParams;
-    ViewContent: ViewContentParams;
-}
-export type StandardEventName = keyof StandardEventParams;
-declare global {
-    interface Window {
-        fbq: {
-            (command: 'init', pixelId: string): void;
-            (command: 'track', eventName: StandardEventName, params?: StandardEventParams[StandardEventName], eventId?: string): void;
-            (command: 'consent', action: 'grant' | 'revoke'): void;
-            (...args: unknown[]): void;
-        };
-        _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;
-    /** Meta Pixel loader URL. */
-    scriptSrc?: string;
-}
-/**
- * Creates a Meta Pixel script.
- *
- * 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
- *
- * @example
- * ```ts
- * const metaPixelScript = metaPixel({
- *   pixelId: '123456789012345',
- * });
- * ```
- *
- * @see {@link https://developers.facebook.com/docs/meta-pixel/get-started} Meta Pixel documentation
- */
-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.
- *
- * @param eventName - The event name to track
- * @param params - Optional parameters to track
- * @param eventId - Optional event ID to track (If using Conversion API)
- *
- * @usage
- * ```ts
- * metaPixelEvent('Purchase', { value: 10.0, currency: 'USD' });
- * ```
- *
- * @see {@link https://developers.facebook.com/docs/meta-pixel/reference} Meta Pixel documentation
- */
-export declare const metaPixelEvent: <TEventName extends StandardEventName>(eventName: TEventName, params?: StandardEventParams[TEventName], eventId?: string) => void;
-export {};