@c15t/scripts 2.2.0 → 3.0.0-alpha.0

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

@@ -1,4 +1,4 @@
-import type { AllConsentNames, Script } from 'c15t';
+import type { AllConsentNames, Script } from '@c15t/core';
 declare global {
     interface Window {
         dataLayer: unknown[];
@@ -14,39 +14,39 @@ declare global {
 export declare const gtagManifest: {
     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 ifUndefined: true;
         readonly name: 'dataLayer';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'defineQueueFunction';
+        readonly ifUndefined: true;
         readonly name: 'gtag';
         readonly queue: 'dataLayer';
-        readonly ifUndefined: true;
+        readonly type: 'defineQueueFunction';
     }];
+    readonly category: '{{category}}';
+    readonly consentMapping: Record<string, string[]>;
+    readonly consentSignal: 'gtag';
     readonly install: [{
-        readonly type: 'callGlobal';
-        readonly global: 'gtag';
         readonly args: ["js", {
             readonly kind: "c15t.runtime-value";
             readonly value: 'date';
         }];
-    }, {
-        readonly type: 'callGlobal';
         readonly global: 'gtag';
+        readonly type: 'callGlobal';
+    }, {
         readonly args: ["config", "{{id}}"];
+        readonly global: 'gtag';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: 'https://www.googletagmanager.com/gtag/js?id={{id}}';
         readonly async: true;
+        readonly src: 'https://www.googletagmanager.com/gtag/js?id={{id}}';
+        readonly type: 'loadScript';
     }];
-    readonly consentMapping: Record<string, string[]>;
-    readonly consentSignal: 'gtag';
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'gtag';
 };
 export interface GtagOptions {
     /**
@@ -90,4 +90,4 @@ export interface GtagOptions {
  * @param options - The options for the gtag script.
  * @returns The Google Tag Manager script.
  */
-export declare function gtag({ id, category, consentMapping, script, }: GtagOptions): Script;
+export declare const gtag: ({ id, category, consentMapping, script, }: GtagOptions) => Script;

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Default Heap config-loader base URL.
  *
@@ -19,9 +19,9 @@ type JsonPrimitive = string | number | boolean | null;
 type JsonValue = JsonPrimitive | JsonValue[] | {
     [key: string]: JsonValue;
 };
-type JsonRecord = {
+interface JsonRecord {
     [key: string]: JsonValue;
-};
+}
 export interface HeapReadyCallback {
     /** Heap method name captured by the pre-load snippet stub. */
     name: (typeof HEAP_QUEUE_METHODS)[number];
@@ -223,43 +223,43 @@ declare global {
 export declare const heapManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'heap';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'heapReadyCb';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'heap';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["heap", "envId"];
+        readonly type: 'setGlobalPath';
         readonly value: '{{envId}}';
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["heap", "appid"];
+        readonly type: 'setGlobalPath';
         readonly value: '{{envId}}';
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["heap", "clientConfig"];
+        readonly type: 'setGlobalPath';
         readonly value: '{{clientConfig}}';
     }, {
-        readonly type: 'defineQueueMethods';
-        readonly target: 'heap';
+        readonly methods: ["init", "startTracking", "stopTracking", "track", "resetIdentity", "identify", "identifyHashed", "getSessionId", "getUserId", "getIdentity", "addUserProperties", "addEventProperties", "removeEventProperty", "clearEventProperties", "addAccountProperties", "addAdapter", "addTransformer", "addTransformerFn", "onReady", "addPageviewProperties", "removePageviewProperty", "clearPageviewProperties", "trackPageview"];
         readonly queue: {
             readonly global: 'heapReadyCb';
         };
         readonly queueFormat: 'callback';
-        readonly methods: ["init", "startTracking", "stopTracking", "track", "resetIdentity", "identify", "identifyHashed", "getSessionId", "getUserId", "getIdentity", "addUserProperties", "addEventProperties", "removeEventProperty", "clearEventProperties", "addAccountProperties", "addAdapter", "addTransformer", "addTransformerFn", "onReady", "addPageviewProperties", "removePageviewProperty", "clearPageviewProperties", "trackPageview"];
+        readonly target: 'heap';
+        readonly type: 'defineQueueMethods';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'heap';
 };
 export interface HeapOptions {
     /**
@@ -312,5 +312,5 @@ export interface HeapOptions {
  * });
  * ```
  */
-export declare function heap({ envId, clientConfig, scriptUrl }: HeapOptions): Script;
+export declare const heap: ({ envId, clientConfig, scriptUrl, }: HeapOptions) => Script;
 export {};

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 export declare const HIGHTOUCH_QUEUE_METHODS: readonly ['trackSubmit', 'trackClick', 'trackLink', 'trackForm', 'pageview', 'identify', 'reset', 'group', 'track', 'ready', 'alias', 'debug', 'page', 'once', 'off', 'on', 'addSourceMiddleware', 'addIntegrationMiddleware', 'setAnonymousId', 'addDestinationMiddleware', 'load'];
 /**
  * Public Hightouch Events browser API exposed on `window.htevents`.
@@ -197,40 +197,40 @@ declare global {
 export declare const hightouchManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'hightouch';
-    readonly category: 'measurement';
     readonly bootstrap: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'htevents';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'defineQueueMethods';
-        readonly target: 'htevents';
         readonly methods: ["trackSubmit", "trackClick", "trackLink", "trackForm", "pageview", "identify", "reset", "group", "track", "ready", "alias", "debug", "page", "once", "off", "on", "addSourceMiddleware", "addIntegrationMiddleware", "setAnonymousId", "addDestinationMiddleware", "load"];
+        readonly target: 'htevents';
+        readonly type: 'defineQueueMethods';
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["htevents", "_writeKey"];
+        readonly type: 'setGlobalPath';
         readonly value: '{{writeKey}}';
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["htevents", "_loadOptions"];
+        readonly type: 'setGlobalPath';
         readonly value: '{{loadOptions}}';
     }];
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'callGlobal';
+        readonly args: ["{{writeKey}}", "{{loadOptions}}"];
         readonly global: 'htevents';
         readonly method: 'load';
-        readonly args: ["{{writeKey}}", "{{loadOptions}}"];
-    }, {
         readonly type: 'callGlobal';
+    }, {
         readonly global: 'htevents';
         readonly method: 'page';
+        readonly type: 'callGlobal';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'hightouch';
 };
 export interface HightouchOptions {
     /**
@@ -282,4 +282,4 @@ export interface HightouchOptions {
  * });
  * ```
  */
-export declare function hightouch({ writeKey, apiHost, trackPageView, scriptUrl, }: HightouchOptions): Script;
+export declare const hightouch: ({ writeKey, apiHost, trackPageView, scriptUrl, }: HightouchOptions) => Script;

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         hj?: ((...args: unknown[]) => void) & {
@@ -19,29 +19,29 @@ declare global {
 export declare const hotjarManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'hotjar';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: '_hjSettings';
+        readonly type: 'setGlobal';
         readonly value: {
             readonly hjid: '{{siteId}}';
             readonly hjsv: '{{version}}';
         };
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'defineStubFunction';
+        readonly ifUndefined: true;
         readonly name: 'hj';
         readonly queue: {
             readonly property: 'q';
         };
         readonly queueFormat: 'array';
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'hotjar';
 };
 export interface HotjarOptions {
     /**
@@ -70,4 +70,4 @@ export interface HotjarOptions {
  * hotjar({ siteId: 1234567 });
  * ```
  */
-export declare function hotjar({ siteId, version, scriptUrl, }: HotjarOptions): Script;
+export declare const hotjar: ({ siteId, version, scriptUrl, }: HotjarOptions) => Script;

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         LogRocket?: {
@@ -23,21 +23,21 @@ declare global {
 export declare const logRocketManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'logrocket';
+    readonly afterLoad: [{
+        readonly args: ["{{appId}}", "{{initOptions}}"];
+        readonly global: 'LogRocket';
+        readonly method: 'init';
+        readonly type: 'callGlobal';
+    }];
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly attributes: {
             readonly crossorigin: 'anonymous';
         };
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
-    readonly afterLoad: [{
-        readonly type: 'callGlobal';
-        readonly global: 'LogRocket';
-        readonly method: 'init';
-        readonly args: ["{{appId}}", "{{initOptions}}"];
-    }];
+    readonly vendor: 'logrocket';
 };
 export interface LogRocketOptions {
     /**
@@ -98,4 +98,4 @@ export interface LogRocketOptions {
  * });
  * ```
  */
-export declare function logRocket(options: LogRocketOptions): Script;
+export declare const logRocket: (options: LogRocketOptions) => Script;

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

@@ -1,5 +1,5 @@
-import type { Script } from 'c15t';
-import { type VendorManifest } from '../../types';
+import type { Script } from '@c15t/core';
+import type { VendorManifest } from '../../types';
 declare global {
     interface Window {
         _paq?: unknown[];
@@ -38,4 +38,4 @@ export interface MatomoAnalyticsOptions {
  * `trackerUrl`/`scriptUrl` values are not supplied). Provide `matomoUrl`, or
  * provide both explicit `trackerUrl` and `scriptUrl`.
  */
-export declare function matomoAnalytics(options?: MatomoAnalyticsOptions): Script;
+export declare const matomoAnalytics: (options?: MatomoAnalyticsOptions) => Script;

package/dist-types/vendors/analytics/microsoft-clarity.d.ts

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 /**
  * Microsoft Clarity Consent V2 storage state.
  *
@@ -24,16 +24,15 @@ export interface ClarityConsentV2Payload {
  * current c15t consent state.
  */
 export type ClarityConsentValue = boolean | Partial<Record<keyof ClarityConsentV2Payload | 'ad_storage' | 'analytics_storage' | 'marketing' | 'measurement' | 'analytics', ClarityConsentState | boolean>>;
-type ClarityFunction = {
+interface ClarityFunction {
     (command: 'consent', value?: boolean): void;
     (command: 'consentv2', value: ClarityConsentV2Payload): void;
-    (command: 'event', value: string): void;
+    (command: 'event' | 'upgrade', value: string): void;
     (command: 'identify', id: string, session?: string, page?: string): unknown;
     (command: 'set', key: string, value: string | string[]): void;
     (command: 'start', options?: Record<string, unknown>): void;
-    (command: 'upgrade', reason: string): void;
     (command: string, ...args: unknown[]): unknown;
-};
+}
 declare global {
     interface Window {
         clarity?: ClarityFunction & {
@@ -50,23 +49,23 @@ declare global {
 export declare const clarityManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'microsoft-clarity';
-    readonly category: 'measurement';
-    readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: 'defineStubFunction';
+        readonly ifUndefined: true;
         readonly name: 'clarity';
         readonly queue: {
             readonly property: 'q';
         };
         readonly queueFormat: 'array';
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly persistAfterConsentRevoked: true;
+    readonly vendor: 'microsoft-clarity';
 };
 export interface ClarityOptions {
     /**
@@ -94,5 +93,5 @@ export interface ClarityOptions {
  * override is provided. Provide a valid Clarity project id string to prevent
  * this error.
  */
-export declare function clarity({ id, defaultConsent, scriptUrl, }: ClarityOptions): Script;
+export declare const clarity: ({ id, defaultConsent, scriptUrl, }: ClarityOptions) => Script;
 export {};

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         mixpanel?: {
@@ -31,51 +31,51 @@ declare global {
 export declare const mixpanelAnalyticsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'mixpanel-analytics';
-    readonly category: 'measurement';
     readonly alwaysLoad: true;
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'setGlobal';
+        readonly ifUndefined: true;
         readonly name: 'mixpanel';
+        readonly type: 'setGlobal';
         readonly value: readonly [];
-        readonly ifUndefined: true;
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["mixpanel", "__SV"];
+        readonly type: 'setGlobalPath';
         readonly value: 1.2;
     }, {
-        readonly type: 'setGlobalPath';
         readonly path: ["mixpanel", "_i"];
+        readonly type: 'setGlobalPath';
         readonly value: readonly [readonly ["{{token}}", "{{initOptions}}", "mixpanel"]];
     }, {
-        readonly type: 'defineQueueMethods';
-        readonly target: 'mixpanel';
         readonly methods: ["track", "identify", "reset", "register", "opt_in_tracking", "opt_out_tracking"];
+        readonly target: 'mixpanel';
+        readonly type: 'defineQueueMethods';
     }, {
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
         readonly async: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
-    readonly onLoadGranted: [{
+    readonly onConsentDenied: [{
+        readonly global: 'mixpanel';
+        readonly method: 'opt_out_tracking';
         readonly type: 'callGlobal';
+    }];
+    readonly onConsentGranted: [{
         readonly global: 'mixpanel';
         readonly method: 'opt_in_tracking';
+        readonly type: 'callGlobal';
     }];
     readonly onLoadDenied: [{
-        readonly type: 'callGlobal';
         readonly global: 'mixpanel';
         readonly method: 'opt_out_tracking';
-    }];
-    readonly onConsentGranted: [{
         readonly type: 'callGlobal';
+    }];
+    readonly onLoadGranted: [{
         readonly global: 'mixpanel';
         readonly method: 'opt_in_tracking';
-    }];
-    readonly onConsentDenied: [{
         readonly type: 'callGlobal';
-        readonly global: 'mixpanel';
-        readonly method: 'opt_out_tracking';
     }];
+    readonly vendor: 'mixpanel-analytics';
 };
 export interface MixpanelAnalyticsOptions {
     /** Your Mixpanel project token. */
@@ -110,4 +110,4 @@ export interface MixpanelAnalyticsOptions {
  * });
  * ```
  */
-export declare function mixpanelAnalytics({ token, initOptions, scriptUrl, }: MixpanelAnalyticsOptions): Script;
+export declare const mixpanelAnalytics: ({ token, initOptions, scriptUrl, }: MixpanelAnalyticsOptions) => Script;

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 declare global {
     interface Window {
         pirsch?: (eventName: string, options?: {
@@ -20,22 +20,22 @@ declare global {
 export declare const pirschManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'pirsch';
     readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
-        readonly defer: true;
         readonly attributes: {
-            readonly id: '{{scriptElementId}}';
             readonly 'data-code': '{{identificationCode}}';
-            readonly 'data-domain': '{{domain}}';
             readonly 'data-dev': '{{dev}}';
-            readonly 'data-hit-endpoint': '{{hitEndpoint}}';
-            readonly 'data-event-endpoint': '{{eventEndpoint}}';
             readonly 'data-disable-page-views': '{{disablePageViews}}';
+            readonly 'data-domain': '{{domain}}';
+            readonly 'data-event-endpoint': '{{eventEndpoint}}';
+            readonly 'data-hit-endpoint': '{{hitEndpoint}}';
+            readonly id: '{{scriptElementId}}';
         };
+        readonly defer: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'pirsch';
 };
 export interface PirschOptions {
     /**
@@ -93,4 +93,4 @@ export interface PirschOptions {
  * });
  * ```
  */
-export declare function pirsch(options: PirschOptions): Script;
+export declare const pirsch: (options: PirschOptions) => Script;

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

@@ -1,4 +1,4 @@
-import type { Script } from 'c15t';
+import type { Script } from '@c15t/core';
 export type PlausibleExtension = 'hash' | 'outbound-links' | 'file-downloads' | 'tagged-events' | 'revenue' | 'pageview-props' | 'compat' | 'local' | 'manual';
 export interface PlausibleInitOptions {
     customProperties?: Record<string, unknown>;
@@ -29,29 +29,29 @@ declare global {
 export declare const plausibleAnalyticsManifest: {
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;
-    readonly vendor: 'plausible-analytics';
-    readonly category: 'measurement';
     readonly bootstrap: [{
-        readonly type: 'defineStubFunction';
+        readonly ifUndefined: true;
         readonly name: 'plausible';
+        readonly properties: {
+            readonly o: '{{initOptions}}';
+        };
         readonly queue: {
             readonly property: 'q';
         };
         readonly queueFormat: 'array';
-        readonly properties: {
-            readonly o: '{{initOptions}}';
-        };
-        readonly ifUndefined: true;
+        readonly type: 'defineStubFunction';
     }];
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: 'loadScript';
-        readonly src: '{{scriptUrl}}';
-        readonly defer: true;
         readonly attributes: {
-            readonly 'data-domain': '{{domain}}';
             readonly 'data-api': '{{apiAttribute}}';
+            readonly 'data-domain': '{{domain}}';
         };
+        readonly defer: true;
+        readonly src: '{{scriptUrl}}';
+        readonly type: 'loadScript';
     }];
+    readonly vendor: 'plausible-analytics';
 };
 export interface PlausibleAnalyticsOptions {
     /**
@@ -119,4 +119,4 @@ export interface PlausibleAnalyticsOptions {
  * });
  * ```
  */
-export declare function plausibleAnalytics(options: PlausibleAnalyticsOptions): Script;
+export declare const plausibleAnalytics: (options: PlausibleAnalyticsOptions) => Script;