@c15t/scripts 2.0.1 → 2.2.0-canary-20260727202135

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 {};

package/dist-types/posthog.d.ts

@@ -1,112 +0,0 @@
-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;