@c15t/scripts 2.0.1 → 2.1.0

package/dist/vendors/functional/intercom.cjs

@@ -0,0 +1,85 @@
+"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__, {
+    intercom: ()=>intercom,
+    intercomManifest: ()=>intercomManifest,
+    INTERCOM_API_BASES: ()=>INTERCOM_API_BASES
+});
+const external_resolve_cjs_namespaceObject = require("../../resolve.cjs");
+const external_types_cjs_namespaceObject = require("../../types.cjs");
+const INTERCOM_API_BASES = {
+    us: 'https://api-iam.intercom.io',
+    eu: 'https://api-iam.eu.intercom.io',
+    au: 'https://api-iam.au.intercom.io'
+};
+const intercomManifest = {
+    ...external_types_cjs_namespaceObject.vendorManifestContract,
+    vendor: 'intercom',
+    category: 'functionality',
+    install: [
+        {
+            type: 'defineStubFunction',
+            name: 'Intercom',
+            queue: {
+                property: 'q'
+            },
+            queueFormat: 'array',
+            ifUndefined: true
+        },
+        {
+            type: 'setGlobal',
+            name: 'intercomSettings',
+            value: '{{settings}}',
+            ifUndefined: false
+        },
+        {
+            type: 'loadScript',
+            src: "{{scriptSrc}}",
+            async: true
+        }
+    ]
+};
+function intercom({ appId, apiBase = INTERCOM_API_BASES.us, settings, scriptSrc }) {
+    return (0, external_resolve_cjs_namespaceObject.resolveManifest)(intercomManifest, {
+        settings: {
+            ...settings ?? {},
+            app_id: appId,
+            api_base: apiBase
+        },
+        scriptSrc: scriptSrc ?? `https://widget.intercom.io/widget/${appId}`
+    });
+}
+exports.INTERCOM_API_BASES = __webpack_exports__.INTERCOM_API_BASES;
+exports.intercom = __webpack_exports__.intercom;
+exports.intercomManifest = __webpack_exports__.intercomManifest;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "INTERCOM_API_BASES",
+    "intercom",
+    "intercomManifest"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/vendors/functional/intercom.js

@@ -0,0 +1,45 @@
+import { resolveManifest } from "../../resolve.js";
+import { vendorManifestContract } from "../../types.js";
+const INTERCOM_API_BASES = {
+    us: 'https://api-iam.intercom.io',
+    eu: 'https://api-iam.eu.intercom.io',
+    au: 'https://api-iam.au.intercom.io'
+};
+const intercomManifest = {
+    ...vendorManifestContract,
+    vendor: 'intercom',
+    category: 'functionality',
+    install: [
+        {
+            type: 'defineStubFunction',
+            name: 'Intercom',
+            queue: {
+                property: 'q'
+            },
+            queueFormat: 'array',
+            ifUndefined: true
+        },
+        {
+            type: 'setGlobal',
+            name: 'intercomSettings',
+            value: '{{settings}}',
+            ifUndefined: false
+        },
+        {
+            type: 'loadScript',
+            src: "{{scriptSrc}}",
+            async: true
+        }
+    ]
+};
+function intercom({ appId, apiBase = INTERCOM_API_BASES.us, settings, scriptSrc }) {
+    return resolveManifest(intercomManifest, {
+        settings: {
+            ...settings ?? {},
+            app_id: appId,
+            api_base: apiBase
+        },
+        scriptSrc: scriptSrc ?? `https://widget.intercom.io/widget/${appId}`
+    });
+}
+export { INTERCOM_API_BASES, intercom, intercomManifest };

package/dist/{google-tag-manager.cjs → vendors/tag-managers/google-tag-manager.cjs}

@@ -27,8 +27,9 @@ __webpack_require__.d(__webpack_exports__, {
     googleTagManagerManifest: ()=>googleTagManagerManifest,
     googleTagManager: ()=>googleTagManager
 });
-const external_resolve_cjs_namespaceObject = require("./resolve.cjs");
-const external_types_cjs_namespaceObject = require("./types.cjs");
+const external_resolve_cjs_namespaceObject = require("../../resolve.cjs");
+const external_types_cjs_namespaceObject = require("../../types.cjs");
+const google_consent_cjs_namespaceObject = require("../_shared/google-consent.cjs");
 const googleTagManagerManifest = {
     ...external_types_cjs_namespaceObject.vendorManifestContract,
     vendor: 'google-tag-manager',
@@ -53,7 +54,7 @@ const googleTagManagerManifest = {
             type: 'pushToQueue',
             queue: 'dataLayer',
             value: {
-                'gtm.start': '{{loadTime}}',
+                'gtm.start': external_types_cjs_namespaceObject.runtimeTimestampValue,
                 event: 'gtm.js'
             }
         },
@@ -73,35 +74,13 @@ const googleTagManagerManifest = {
             ]
         }
     ],
-    consentMapping: {
-        necessary: [
-            'security_storage'
-        ],
-        functionality: [
-            'functionality_storage'
-        ],
-        measurement: [
-            'analytics_storage'
-        ],
-        marketing: [
-            'ad_storage',
-            'ad_user_data',
-            'ad_personalization'
-        ],
-        experience: [
-            'personalization_storage'
-        ]
-    },
+    consentMapping: google_consent_cjs_namespaceObject.GOOGLE_CONSENT_MODE_V2_DEFAULT_MAPPING,
     consentSignal: 'gtag'
 };
 function googleTagManager({ id, updateEventName, consentMapping }) {
-    const manifest = consentMapping ? {
-        ...googleTagManagerManifest,
-        consentMapping
-    } : googleTagManagerManifest;
+    const manifest = (0, google_consent_cjs_namespaceObject.withOptionalConsentMapping)(googleTagManagerManifest, consentMapping);
     const resolved = (0, external_resolve_cjs_namespaceObject.resolveManifest)(manifest, {
         id,
-        loadTime: Date.now(),
         updateEventName: updateEventName ?? 'consent-update'
     });
     return resolved;

package/dist/{google-tag-manager.js → vendors/tag-managers/google-tag-manager.js}

@@ -1,5 +1,6 @@
-import { resolveManifest } from "./resolve.js";
-import { vendorManifestContract } from "./types.js";
+import { resolveManifest } from "../../resolve.js";
+import { runtimeTimestampValue, vendorManifestContract } from "../../types.js";
+import { GOOGLE_CONSENT_MODE_V2_DEFAULT_MAPPING, withOptionalConsentMapping } from "../_shared/google-consent.js";
 const googleTagManagerManifest = {
     ...vendorManifestContract,
     vendor: 'google-tag-manager',
@@ -24,7 +25,7 @@ const googleTagManagerManifest = {
             type: 'pushToQueue',
             queue: 'dataLayer',
             value: {
-                'gtm.start': '{{loadTime}}',
+                'gtm.start': runtimeTimestampValue,
                 event: 'gtm.js'
             }
         },
@@ -44,35 +45,13 @@ const googleTagManagerManifest = {
             ]
         }
     ],
-    consentMapping: {
-        necessary: [
-            'security_storage'
-        ],
-        functionality: [
-            'functionality_storage'
-        ],
-        measurement: [
-            'analytics_storage'
-        ],
-        marketing: [
-            'ad_storage',
-            'ad_user_data',
-            'ad_personalization'
-        ],
-        experience: [
-            'personalization_storage'
-        ]
-    },
+    consentMapping: GOOGLE_CONSENT_MODE_V2_DEFAULT_MAPPING,
     consentSignal: 'gtag'
 };
 function googleTagManager({ id, updateEventName, consentMapping }) {
-    const manifest = consentMapping ? {
-        ...googleTagManagerManifest,
-        consentMapping
-    } : googleTagManagerManifest;
+    const manifest = withOptionalConsentMapping(googleTagManagerManifest, consentMapping);
     const resolved = resolveManifest(manifest, {
         id,
-        loadTime: Date.now(),
         updateEventName: updateEventName ?? 'consent-update'
     });
     return resolved;

package/dist-types/__tests__/helpers.d.ts

@@ -0,0 +1,141 @@
+import type { ConsentState, Script, ScriptCallbackInfo } from 'c15t';
+import { type BuiltInScriptIntegrationKey } from '../registry';
+/**
+ * Typed view of `globalThis` used by script helper tests.
+ *
+ * Additional string-keyed properties model browser and vendor globals created
+ * during setup and individual test cases.
+ */
+export type TestGlobal = typeof globalThis & Record<string, unknown>;
+/**
+ * Snapshot of the script fields asserted by helper tests.
+ */
+export interface HelperScriptSnapshot {
+    /** Unique script identifier generated by the helper under test. */
+    id: string;
+    /** Consent category associated with the script integration. */
+    category: unknown;
+    /** Whether the script should load even before optional consent is granted. */
+    alwaysLoad?: boolean;
+    /** Whether the script stays loaded after consent for its category is revoked. */
+    persistAfterConsentRevoked?: boolean;
+    /** Remote script URL emitted by the helper, when applicable. */
+    src?: string;
+}
+/**
+ * Expected integration metadata and script attributes for a helper assertion.
+ */
+export interface ExpectedScriptSnapshot {
+    /** Expected `alwaysLoad` flag from the generated helper script. */
+    alwaysLoad: boolean | undefined;
+    /** Expected consent-revocation persistence flag from the generated script. */
+    persistAfterConsentRevoked: boolean | undefined;
+    /** Expected remote script URL from the generated helper script. */
+    src: string;
+}
+/**
+ * Consent state with only required storage enabled.
+ *
+ * `necessary` keeps essential storage on, `functionality` covers site
+ * preferences, `measurement` controls analytics, `marketing` controls
+ * advertising-related storage, and `experience` controls personalization.
+ */
+export declare const deniedConsentState: ConsentState;
+/**
+ * Consent state with required and measurement storage enabled.
+ *
+ * `necessary` keeps essential storage on, `functionality` covers site
+ * preferences, `measurement` controls analytics, `marketing` controls
+ * advertising-related storage, and `experience` controls personalization.
+ */
+export declare const grantedMeasurementConsentState: ConsentState;
+/**
+ * Required callback fields for creating a script lifecycle payload in tests.
+ */
+export type CallbackInfoOverrides = Partial<ScriptCallbackInfo> & Pick<ScriptCallbackInfo, 'id'>;
+/**
+ * Creates a fully typed callback payload for script lifecycle tests.
+ *
+ * Defaults model a denied-consent callback for the same DOM element ID as the
+ * script ID, while allowing individual tests to override the relevant fields.
+ */
+export declare function createCallbackInfo(overrides: CallbackInfoOverrides): ScriptCallbackInfo;
+export type LifecycleCallbackOverrides = Partial<Omit<ScriptCallbackInfo, 'id'>>;
+export declare function runOnBeforeLoad(script: Pick<Script, 'id' | 'onBeforeLoad'>, overrides?: LifecycleCallbackOverrides): void;
+/**
+ * Returns a mutable test-friendly reference to the global object.
+ *
+ * @returns The current global object cast to `TestGlobal`.
+ *
+ * @example
+ * ```ts
+ * const globalRef = getTestGlobal();
+ * globalRef.dataLayer = [];
+ * ```
+ */
+export declare function getTestGlobal(): TestGlobal;
+/**
+ * Registers browser-like setup and teardown hooks for script helper tests.
+ *
+ * Before each test, this installs mocked `window` and `document` globals.
+ * After each test, it unstubs globals and removes vendor-specific globals left
+ * behind by script execution.
+ *
+ * @returns Nothing.
+ *
+ * @example
+ * ```ts
+ * describe('googleTagManager', () => {
+ * 	setupScriptHelperTest();
+ * });
+ * ```
+ */
+export declare function setupScriptHelperTest(): void;
+/**
+ * Asserts that a helper-generated script matches registry metadata and
+ * expected script fields.
+ *
+ * @param key - Built-in integration key used to find the registry entry.
+ * @param script - Snapshot of the helper-generated script under test.
+ * @param expected - Expected script metadata and output for the assertion.
+ * @returns Nothing.
+ *
+ * @remarks
+ * If `key` does not match any built-in integration, the assertion fails before
+ * the non-null access is used.
+ *
+ * @example
+ * ```ts
+ * expectScriptMatchesIntegration(
+ * 	'googleTagManager',
+ * 	googleTagManager({ id: 'GTM-123' }),
+ * 	{
+ * 		alwaysLoad: true,
+ * 		persistAfterConsentRevoked: undefined,
+ * 		src: 'https://www.googletagmanager.com/gtm.js?id=GTM-123',
+ * 	}
+ * );
+ * ```
+ */
+export declare function expectScriptMatchesIntegration(key: BuiltInScriptIntegrationKey, script: HelperScriptSnapshot, expected: ExpectedScriptSnapshot): void;
+/**
+ * Converts an array-like value into a plain array.
+ *
+ * @param value - Array-like input such as `arguments`, a `NodeList`, or a
+ * vendor queue entry.
+ * @returns A new array containing the indexed values from `value`.
+ *
+ * @remarks
+ * Passing `null` or `undefined` throws because `slice` requires an object-like
+ * value.
+ *
+ * @example
+ * ```ts
+ * function collectArgs(...args: unknown[]) {
+ * 	return toArgumentsArray(args);
+ * }
+ * ```
+ */
+export declare function toArgumentsArray(value: unknown): unknown[];
+export declare function expectGoogleConsentDefault(entry: unknown): void;
+export declare function expectStubCommandQueue(stub: unknown, queueKey: string, commands: unknown[][]): void;

package/dist-types/engine/runtime.d.ts

@@ -1,3 +1,3 @@
 import { type Script } from 'c15t';
-import type { ResolvedManifest } from '../types';
+import { type ResolvedManifest } from '../types';
 export declare function resolvedManifestToScript(resolvedManifest: ResolvedManifest): Script;