@c15t/scripts 2.1.0 → 2.2.0-canary-20260804162155

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

@@ -17,18 +17,18 @@ declare global {
  * and unloaded when consent is revoked.
  */
 export declare const ahrefsAnalyticsManifest: {
-    readonly vendor: "ahrefs-analytics";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'ahrefs-analytics';
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
         readonly attributes: {
-            readonly 'data-key': "{{key}}";
+            readonly 'data-key': '{{key}}';
         };
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface AhrefsAnalyticsOptions {
     /**

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

@@ -0,0 +1,234 @@
+import type { Script } from 'c15t';
+/**
+ * Browser SDK 2 version used by the default Amplitude CDN loader URL.
+ *
+ * The Amplitude Browser SDK 2 public bundle path is versioned. A
+ * `analytics-browser-latest-min.js.gz` path is not publicly available, so c15t
+ * pins a known Browser SDK 2 version by default and lets callers override the
+ * loader through `scriptUrl`.
+ */
+export declare const DEFAULT_AMPLITUDE_BROWSER_SDK_VERSION = "2.44.4";
+/**
+ * Default Amplitude Browser SDK 2 loader URL.
+ */
+export declare const DEFAULT_AMPLITUDE_SCRIPT_URL = "https://cdn.amplitude.com/libs/analytics-browser-2.44.4-min.js.gz";
+/**
+ * Core Amplitude Browser SDK 2 methods queued before the real SDK loads.
+ *
+ * These methods use Amplitude's Browser SDK 2 snippet queue contract:
+ * `window.amplitude._q` receives `{ name, args, resolve }` records, and the
+ * loaded SDK drains that queue when `window.amplitude.invoked` is true.
+ */
+export declare const AMPLITUDE_PROMISE_QUEUE_METHODS: readonly ['init', 'track', 'identify', 'flush'];
+/**
+ * Queue methods Amplitude's snippet treats as synchronous — they queue the
+ * call but return nothing.
+ */
+export declare const AMPLITUDE_SYNC_QUEUE_METHODS: readonly ['setUserId', 'setOptOut'];
+export declare const AMPLITUDE_QUEUE_METHODS: readonly ["init", "track", "identify", "flush", "setUserId", "setOptOut"];
+/**
+ * Amplitude Identify helper methods queued before the real SDK loads.
+ */
+export declare const AMPLITUDE_IDENTIFY_METHODS: readonly ['set', 'setOnce', 'add', 'append', 'prepend', 'preInsert', 'postInsert', 'remove', 'unset', 'clearAll', 'getUserProperties'];
+/**
+ * Queue entry consumed by Amplitude Browser SDK 2 at load time.
+ */
+export interface AmplitudeQueueEntry {
+    /** Name of the Amplitude method to invoke after the SDK loads. */
+    name: (typeof AMPLITUDE_QUEUE_METHODS)[number];
+    /** Arguments originally passed to the queued method. */
+    args: unknown[];
+    /** Promise resolver called by the SDK after the queued method runs. */
+    resolve: (value: unknown) => void;
+}
+/**
+ * Queue entry stored by an Amplitude Identify helper created before load.
+ */
+export interface AmplitudeIdentifyQueueEntry {
+    /** Identify helper method to replay after the SDK loads. */
+    name: (typeof AMPLITUDE_IDENTIFY_METHODS)[number];
+    /** Arguments originally passed to the helper method. */
+    args: unknown[];
+}
+/**
+ * Pre-load Amplitude Identify helper.
+ */
+export interface AmplitudeIdentify {
+    /** Queued Identify helper operations. */
+    _q?: AmplitudeIdentifyQueueEntry[];
+    /** Queue a `$set` identify operation. */
+    set: (property: string, value: unknown) => this;
+    /** Queue a `$setOnce` identify operation. */
+    setOnce: (property: string, value: unknown) => this;
+    /** Queue an `$add` identify operation. */
+    add: (property: string, value: number) => this;
+    /** Queue an `$append` identify operation. */
+    append: (property: string, value: unknown) => this;
+    /** Queue a `$prepend` identify operation. */
+    prepend: (property: string, value: unknown) => this;
+    /** Queue a `$preInsert` identify operation. */
+    preInsert: (property: string, value: unknown) => this;
+    /** Queue a `$postInsert` identify operation. */
+    postInsert: (property: string, value: unknown) => this;
+    /** Queue a `$remove` identify operation. */
+    remove: (property: string, value: unknown) => this;
+    /** Queue an `$unset` identify operation. */
+    unset: (property: string) => this;
+    /** Queue a `$clearAll` identify operation. */
+    clearAll: () => this;
+    /** Queue a read of the accumulated user property operations. */
+    getUserProperties: () => this;
+}
+/**
+ * Minimal public Amplitude Browser SDK 2 API exposed on `window.amplitude`.
+ *
+ * The real SDK replaces the pre-load stub with these methods after the loader
+ * executes. Calls made before load return promises that resolve once the SDK
+ * replays them.
+ */
+export interface AmplitudeApi {
+    /** Amplitude Browser SDK 2 pre-load queue. */
+    _q?: AmplitudeQueueEntry[];
+    /** Named-instance queue registry used by the official snippet contract. */
+    _iq?: Record<string, unknown>;
+    /** Marker that tells the SDK to replay snippet-queued calls. */
+    invoked?: boolean;
+    /** Pre-load Identify helper constructor. */
+    Identify?: new () => AmplitudeIdentify;
+    /** Initialize the default Amplitude instance. */
+    init: (apiKey: string, options?: Record<string, unknown>) => Promise<unknown> | unknown;
+    /** Track an event with optional event properties. */
+    track: (eventInput: string | Record<string, unknown>, eventProperties?: Record<string, unknown>) => Promise<unknown> | unknown;
+    /** Send an identify call. */
+    identify: (identifyPayload: AmplitudeIdentify, eventOptions?: Record<string, unknown>) => Promise<unknown> | unknown;
+    /** Set the current user identifier. */
+    setUserId: (userId: string | undefined) => Promise<unknown> | unknown;
+    /** Toggle runtime opt-out. */
+    setOptOut: (optOut: boolean) => Promise<unknown> | unknown;
+    /** Flush pending events. */
+    flush: () => Promise<unknown> | unknown;
+}
+declare global {
+    interface Window {
+        amplitude?: AmplitudeApi;
+    }
+}
+/**
+ * Amplitude vendor manifest.
+ *
+ * Implements the essential Browser SDK 2 script-loader contract with
+ * `window.amplitude.invoked`, an `_q` method-call queue, and an `_iq` registry
+ * for named instances. It also defines the `Identify` queued helper used by
+ * pre-load `identify()` calls. c15t gates the loader on `measurement` consent,
+ * queues `init(apiKey, initOptions)` before the bundle loads, and uses
+ * `setOptOut(false)` / `setOptOut(true)` for runtime consent changes after the
+ * SDK has loaded.
+ */
+export declare const amplitudeManifest: {
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'amplitude';
+    readonly category: 'measurement';
+    readonly install: [{
+        readonly type: 'setGlobal';
+        readonly name: 'amplitude';
+        readonly value: {
+            readonly _q: readonly [];
+            readonly _iq: {};
+            readonly invoked: true;
+        };
+        readonly ifUndefined: true;
+    }, {
+        readonly type: 'defineQueueClass';
+        readonly target: 'amplitude';
+        readonly name: 'Identify';
+        readonly queueProperty: '_q';
+        readonly methods: ["set", "setOnce", "add", "append", "prepend", "preInsert", "postInsert", "remove", "unset", "clearAll", "getUserProperties"];
+    }, {
+        readonly type: 'defineQueueMethods';
+        readonly target: 'amplitude';
+        readonly queue: {
+            readonly property: '_q';
+        };
+        readonly queueFormat: 'wrappedMethodCall';
+        readonly methods: ["init", "track", "identify", "flush"];
+    }, {
+        readonly type: 'defineQueueMethods';
+        readonly target: 'amplitude';
+        readonly queue: {
+            readonly property: '_q';
+        };
+        readonly queueFormat: 'voidMethodCall';
+        readonly methods: ["setUserId", "setOptOut"];
+    }, {
+        readonly type: 'callGlobal';
+        readonly global: 'amplitude';
+        readonly method: 'init';
+        readonly args: ["{{apiKey}}", "{{initOptions}}"];
+    }, {
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
+        readonly async: true;
+    }];
+    readonly onLoadDenied: [{
+        readonly type: 'callGlobal';
+        readonly global: 'amplitude';
+        readonly method: 'setOptOut';
+        readonly args: [true];
+    }];
+    readonly onConsentGranted: [{
+        readonly type: 'callGlobal';
+        readonly global: 'amplitude';
+        readonly method: 'setOptOut';
+        readonly args: [false];
+    }];
+    readonly onConsentDenied: [{
+        readonly type: 'callGlobal';
+        readonly global: 'amplitude';
+        readonly method: 'setOptOut';
+        readonly args: [true];
+    }];
+};
+export interface AmplitudeOptions {
+    /** Amplitude project API key. */
+    apiKey: string;
+    /**
+     * Amplitude Browser SDK 2 initialization options.
+     *
+     * Values are serialized into the manifest, so use JSON-serializable values
+     * only: plain objects, arrays, strings, numbers, booleans, and `null`.
+     */
+    initOptions?: Record<string, unknown>;
+    /**
+     * Optional Amplitude loader URL override.
+     *
+     * @default 'https://cdn.amplitude.com/libs/analytics-browser-2.44.4-min.js.gz'
+     */
+    scriptUrl?: string;
+}
+/**
+ * Creates an Amplitude Browser SDK 2 script.
+ *
+ * @param options - The options for the Amplitude script.
+ * @returns The Amplitude script configuration.
+ * @throws {Error} When `apiKey` is missing or only whitespace.
+ *
+ * @remarks
+ * The generated script is gated on `measurement` consent. It does not load the
+ * Amplitude SDK until measurement consent is granted; after the SDK is loaded,
+ * later consent changes call `amplitude.setOptOut(false)` or
+ * `amplitude.setOptOut(true)`.
+ *
+ * @example
+ * ```ts
+ * import { amplitude } from '@c15t/scripts/amplitude';
+ *
+ * const script = amplitude({
+ * 	apiKey: 'AMPLITUDE_API_KEY',
+ * 	initOptions: {
+ * 		autocapture: false,
+ * 	},
+ * });
+ * ```
+ */
+export declare function amplitude({ apiKey, initOptions, scriptUrl, }: AmplitudeOptions): Script;

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

@@ -0,0 +1,60 @@
+import type { Script } from 'c15t';
+/**
+ * Clearbit vendor manifest.
+ *
+ * Loads Clearbit's visitor and company enrichment tag from the account-keyed
+ * `tags.js` endpoint. Clearbit enrichment can identify visitors and companies,
+ * so the default consent category is `marketing` rather than `measurement`.
+ * The GitHub issue left the category open between measurement and marketing;
+ * c15t treats enrichment and intent profiling as marketing-sensitive.
+ */
+export declare const clearbitManifest: {
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'clearbit';
+    readonly category: 'marketing';
+    readonly install: [{
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
+        readonly attributes: {
+            readonly referrerpolicy: 'strict-origin-when-cross-origin';
+        };
+    }];
+};
+export interface ClearbitOptions {
+    /**
+     * Your Clearbit publishable key.
+     */
+    publishableKey: string;
+    /**
+     * Custom loader URL.
+     * @default `https://tag.clearbitscripts.com/v1/{publishableKey}/tags.js`
+     */
+    scriptUrl?: string;
+}
+/**
+ * Creates a Clearbit enrichment script.
+ *
+ * @see https://help.clearbit.com/hc/en-us/articles/4420022080783 — installing the Clearbit tag
+ *
+ * @param options - The options for the Clearbit script.
+ * @returns The Clearbit script.
+ * @throws {Error} When `publishableKey` is missing, empty, or invalid.
+ * Provide a valid non-empty `publishableKey` string to prevent this error.
+ *
+ * @remarks
+ * Clearbit identifies visitors and companies for enrichment and intent use
+ * cases. This helper therefore uses the `marketing` consent category by
+ * default even though Clearbit is listed with analytics integrations for
+ * discovery.
+ *
+ * @example
+ * ```ts
+ * import { clearbit } from '@c15t/scripts/clearbit';
+ *
+ * clearbit({
+ *   publishableKey: 'YOUR_PUBLISHABLE_KEY',
+ * });
+ * ```
+ */
+export declare function clearbit(options: ClearbitOptions): Script;

package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts

@@ -15,18 +15,18 @@ declare global {
  * `measurement` and unloaded when consent is revoked.
  */
 export declare const cloudflareWebAnalyticsManifest: {
-    readonly vendor: "cloudflare-web-analytics";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'cloudflare-web-analytics';
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly defer: true;
         readonly attributes: {
-            readonly 'data-cf-beacon': "{{beaconConfig}}";
+            readonly 'data-cf-beacon': '{{beaconConfig}}';
         };
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface CloudflareWebAnalyticsOptions {
     /**

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

@@ -27,63 +27,63 @@ declare global {
  * Config is seeded via `window.databuddyConfig` before the script loads.
  */
 export declare const databuddyManifest: {
-    readonly vendor: "databuddy";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'databuddy';
+    readonly category: 'measurement';
     readonly alwaysLoad: true;
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
         readonly attributes: {
-            readonly crossorigin: "anonymous";
-            readonly 'data-client-id': "{{clientId}}";
-            readonly 'data-api-url': "{{apiUrl}}";
+            readonly crossorigin: 'anonymous';
+            readonly 'data-client-id': '{{clientId}}';
+            readonly 'data-api-url': '{{apiUrl}}';
         };
     }];
     readonly onBeforeLoadGranted: [{
-        readonly type: "setGlobal";
-        readonly name: "databuddyConfig";
-        readonly value: "{{configWhenGranted}}";
+        readonly type: 'setGlobal';
+        readonly name: 'databuddyConfig';
+        readonly value: '{{configWhenGranted}}';
         readonly ifUndefined: true;
     }];
     readonly onBeforeLoadDenied: [{
-        readonly type: "setGlobal";
-        readonly name: "databuddyConfig";
-        readonly value: "{{configWhenDenied}}";
+        readonly type: 'setGlobal';
+        readonly name: 'databuddyConfig';
+        readonly value: '{{configWhenDenied}}';
         readonly ifUndefined: true;
     }];
     readonly onLoadGranted: [{
-        readonly type: "setGlobalPath";
+        readonly type: 'setGlobalPath';
         readonly path: ["databuddy", "options", "disabled"];
         readonly value: false;
     }];
     readonly onLoadDenied: [{
-        readonly type: "setGlobalPath";
+        readonly type: 'setGlobalPath';
         readonly path: ["databuddy", "options", "disabled"];
         readonly value: true;
     }];
     readonly onConsentGranted: [{
-        readonly type: "setGlobal";
-        readonly name: "databuddyConfig";
-        readonly value: "{{configWhenGranted}}";
+        readonly type: 'setGlobal';
+        readonly name: 'databuddyConfig';
+        readonly value: '{{configWhenGranted}}';
         readonly ifUndefined: false;
     }, {
-        readonly type: "setGlobalPath";
+        readonly type: 'setGlobalPath';
         readonly path: ["databuddy", "options", "disabled"];
         readonly value: false;
     }];
     readonly onConsentDenied: [{
-        readonly type: "setGlobal";
-        readonly name: "databuddyConfig";
-        readonly value: "{{configWhenDenied}}";
+        readonly type: 'setGlobal';
+        readonly name: 'databuddyConfig';
+        readonly value: '{{configWhenDenied}}';
         readonly ifUndefined: false;
     }, {
-        readonly type: "setGlobalPath";
+        readonly type: 'setGlobalPath';
         readonly path: ["databuddy", "options", "disabled"];
         readonly value: true;
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface DatabuddyConsentOptions {
     /**

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

@@ -23,22 +23,22 @@ declare global {
  * unloaded when consent is revoked.
  */
 export declare const fathomAnalyticsManifest: {
-    readonly vendor: "fathom-analytics";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'fathom-analytics';
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly defer: true;
         readonly attributes: {
-            readonly 'data-site': "{{site}}";
-            readonly 'data-spa': "{{spa}}";
-            readonly 'data-auto': "{{autoAttribute}}";
-            readonly 'data-canonical': "{{canonicalAttribute}}";
-            readonly 'data-honor-dnt': "{{honorDntAttribute}}";
+            readonly 'data-site': '{{site}}';
+            readonly 'data-spa': '{{spa}}';
+            readonly 'data-auto': '{{autoAttribute}}';
+            readonly 'data-canonical': '{{canonicalAttribute}}';
+            readonly 'data-honor-dnt': '{{honorDntAttribute}}';
         };
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface FathomAnalyticsOptions {
     /**

package/dist-types/vendors/analytics/google-tag.d.ts

@@ -12,41 +12,41 @@ declare global {
  * Uses the same Consent Mode v2 mapping.
  */
 export declare const gtagManifest: {
-    readonly vendor: "gtag";
-    readonly category: "{{category}}";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'gtag';
+    readonly category: '{{category}}';
     readonly alwaysLoad: true;
     readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: "setGlobal";
-        readonly name: "dataLayer";
+        readonly type: 'setGlobal';
+        readonly name: 'dataLayer';
         readonly value: readonly [];
         readonly ifUndefined: true;
     }, {
-        readonly type: "defineQueueFunction";
-        readonly name: "gtag";
-        readonly queue: "dataLayer";
+        readonly type: 'defineQueueFunction';
+        readonly name: 'gtag';
+        readonly queue: 'dataLayer';
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "callGlobal";
-        readonly global: "gtag";
+        readonly type: 'callGlobal';
+        readonly global: 'gtag';
         readonly args: ["js", {
             readonly kind: "c15t.runtime-value";
-            readonly value: "date";
+            readonly value: 'date';
         }];
     }, {
-        readonly type: "callGlobal";
-        readonly global: "gtag";
+        readonly type: 'callGlobal';
+        readonly global: 'gtag';
         readonly args: ["config", "{{id}}"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "https://www.googletagmanager.com/gtag/js?id={{id}}";
+        readonly type: 'loadScript';
+        readonly src: 'https://www.googletagmanager.com/gtag/js?id={{id}}';
         readonly async: true;
     }];
     readonly consentMapping: Record<string, string[]>;
-    readonly consentSignal: "gtag";
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
+    readonly consentSignal: 'gtag';
 };
 export interface GtagOptions {
     /**