@c15t/scripts 2.0.0-rc.0 → 2.0.0

package/README.md

@@ -11,7 +11,7 @@
 
 [![GitHub stars](https://img.shields.io/github/stars/c15t/c15t?style=flat-square)](https://github.com/c15t/c15t)
 [![CI](https://img.shields.io/github/actions/workflow/status/c15t/c15t/ci.yml?style=flat-square)](https://github.com/c15t/c15t/actions/workflows/ci.yml)
-[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg?style=flat-square)](https://github.com/c15t/c15t/blob/main/LICENSE.md)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](https://github.com/c15t/c15t/blob/main/LICENSE.md)
 [![Discord](https://img.shields.io/discord/1312171102268690493?style=flat-square)](https://c15t.link/discord)
 [![npm version](https://img.shields.io/npm/v/%40c15t%2Fscripts?style=flat-square)](https://www.npmjs.com/package/@c15t/scripts)
 [![Top Language](https://img.shields.io/github/languages/top/c15t/c15t?style=flat-square)](https://github.com/c15t/c15t)
@@ -74,8 +74,8 @@ Our preference is that you make use of GitHub's private vulnerability reporting
 
 ## License
 
-[GNU General Public License v3.0](https://github.com/c15t/c15t/blob/main/LICENSE.md)
+[Apache License 2.0](https://github.com/c15t/c15t/blob/main/LICENSE.md)
 
 ---
 
-**Built with ❤️ by the [consent.io](https://www.consent.io?utm_source=github&utm_medium=repopage_%40c15t%2Fscripts) team**
+**Built by [Inth](https://inth.com?utm_source=github&utm_medium=repopage_%40c15t%2Fscripts)**

package/dist/databuddy.cjs

@@ -13,7 +13,7 @@ var __webpack_require__ = {};
 })();
 (()=>{
     __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
             value: 'Module'
         });
         Object.defineProperty(exports1, '__esModule', {
@@ -24,61 +24,116 @@ var __webpack_require__ = {};
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
+    databuddyManifest: ()=>databuddyManifest,
     databuddy: ()=>databuddy
 });
-function databuddy(options) {
-    const { script } = options;
-    const handleConsentOpt = (hasConsent)=>{
-        if (!window.databuddy) return;
-        if (hasConsent && window.databuddy.options.disabled) window.databuddy.options.disabled = false;
-        else if (!hasConsent && !window.databuddy.options.disabled) window.databuddy.options.disabled = true;
-    };
-    return {
-        id: script?.id ?? 'databuddy',
-        category: script?.category ?? 'measurement',
-        src: options.scriptUrl ?? 'https://cdn.databuddy.cc/databuddy.js',
-        async: true,
-        attributes: {
-            crossorigin: 'anonymous',
-            'data-client-id': options.clientId,
-            ...options.apiUrl ? {
-                'data-api-url': options.apiUrl
-            } : {}
-        },
-        alwaysLoad: true,
-        onBeforeLoad: ({ hasConsent, ...rest })=>{
-            if (!window.databuddyConfig) window.databuddyConfig = {
-                clientId: options.clientId,
-                ...options.apiUrl ? {
-                    apiUrl: options.apiUrl
-                } : {},
-                ...options.options || {},
-                disabled: !hasConsent
-            };
-            script?.onBeforeLoad?.({
-                hasConsent,
-                ...rest
-            });
+const external_resolve_cjs_namespaceObject = require("./resolve.cjs");
+const external_types_cjs_namespaceObject = require("./types.cjs");
+const databuddyManifest = {
+    ...external_types_cjs_namespaceObject.vendorManifestContract,
+    vendor: 'databuddy',
+    category: 'measurement',
+    alwaysLoad: true,
+    install: [
+        {
+            type: 'loadScript',
+            src: "{{scriptUrl}}",
+            async: true,
+            attributes: {
+                crossorigin: 'anonymous',
+                'data-client-id': '{{clientId}}',
+                'data-api-url': '{{apiUrl}}'
+            }
+        }
+    ],
+    onBeforeLoadGranted: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenGranted}}',
+            ifUndefined: true
+        }
+    ],
+    onBeforeLoadDenied: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenDenied}}',
+            ifUndefined: true
+        }
+    ],
+    onLoadGranted: [
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: false
+        }
+    ],
+    onLoadDenied: [
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: true
+        }
+    ],
+    onConsentGranted: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenGranted}}',
+            ifUndefined: false
         },
-        onLoad: ({ hasConsent, ...rest })=>{
-            if (window.databuddy) handleConsentOpt(hasConsent);
-            script?.onLoad?.({
-                hasConsent,
-                ...rest
-            });
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: false
+        }
+    ],
+    onConsentDenied: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenDenied}}',
+            ifUndefined: false
         },
-        onConsentChange: ({ hasConsent, ...rest })=>{
-            handleConsentOpt(hasConsent);
-            script?.onConsentChange?.({
-                hasConsent,
-                ...rest
-            });
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: true
         }
-    };
+    ]
+};
+function databuddy(options) {
+    const resolved = (0, external_resolve_cjs_namespaceObject.resolveManifest)(databuddyManifest, {
+        clientId: options.clientId,
+        apiUrl: options.apiUrl,
+        configWhenGranted: options.configWhenGranted,
+        configWhenDenied: options.configWhenDenied,
+        scriptUrl: options.scriptUrl ?? 'https://cdn.databuddy.cc/databuddy.js'
+    });
+    return resolved;
 }
 exports.databuddy = __webpack_exports__.databuddy;
+exports.databuddyManifest = __webpack_exports__.databuddyManifest;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
-    "databuddy"
+    "databuddy",
+    "databuddyManifest"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true

package/dist/databuddy.js

@@ -1,51 +1,103 @@
-function databuddy(options) {
-    const { script } = options;
-    const handleConsentOpt = (hasConsent)=>{
-        if (!window.databuddy) return;
-        if (hasConsent && window.databuddy.options.disabled) window.databuddy.options.disabled = false;
-        else if (!hasConsent && !window.databuddy.options.disabled) window.databuddy.options.disabled = true;
-    };
-    return {
-        id: script?.id ?? 'databuddy',
-        category: script?.category ?? 'measurement',
-        src: options.scriptUrl ?? 'https://cdn.databuddy.cc/databuddy.js',
-        async: true,
-        attributes: {
-            crossorigin: 'anonymous',
-            'data-client-id': options.clientId,
-            ...options.apiUrl ? {
-                'data-api-url': options.apiUrl
-            } : {}
-        },
-        alwaysLoad: true,
-        onBeforeLoad: ({ hasConsent, ...rest })=>{
-            if (!window.databuddyConfig) window.databuddyConfig = {
-                clientId: options.clientId,
-                ...options.apiUrl ? {
-                    apiUrl: options.apiUrl
-                } : {},
-                ...options.options || {},
-                disabled: !hasConsent
-            };
-            script?.onBeforeLoad?.({
-                hasConsent,
-                ...rest
-            });
+import { resolveManifest } from "./resolve.js";
+import { vendorManifestContract } from "./types.js";
+const databuddyManifest = {
+    ...vendorManifestContract,
+    vendor: 'databuddy',
+    category: 'measurement',
+    alwaysLoad: true,
+    install: [
+        {
+            type: 'loadScript',
+            src: "{{scriptUrl}}",
+            async: true,
+            attributes: {
+                crossorigin: 'anonymous',
+                'data-client-id': '{{clientId}}',
+                'data-api-url': '{{apiUrl}}'
+            }
+        }
+    ],
+    onBeforeLoadGranted: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenGranted}}',
+            ifUndefined: true
+        }
+    ],
+    onBeforeLoadDenied: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenDenied}}',
+            ifUndefined: true
+        }
+    ],
+    onLoadGranted: [
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: false
+        }
+    ],
+    onLoadDenied: [
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: true
+        }
+    ],
+    onConsentGranted: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenGranted}}',
+            ifUndefined: false
         },
-        onLoad: ({ hasConsent, ...rest })=>{
-            if (window.databuddy) handleConsentOpt(hasConsent);
-            script?.onLoad?.({
-                hasConsent,
-                ...rest
-            });
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: false
+        }
+    ],
+    onConsentDenied: [
+        {
+            type: 'setGlobal',
+            name: 'databuddyConfig',
+            value: '{{configWhenDenied}}',
+            ifUndefined: false
         },
-        onConsentChange: ({ hasConsent, ...rest })=>{
-            handleConsentOpt(hasConsent);
-            script?.onConsentChange?.({
-                hasConsent,
-                ...rest
-            });
+        {
+            type: 'setGlobalPath',
+            path: [
+                'databuddy',
+                'options',
+                'disabled'
+            ],
+            value: true
         }
-    };
+    ]
+};
+function databuddy(options) {
+    const resolved = resolveManifest(databuddyManifest, {
+        clientId: options.clientId,
+        apiUrl: options.apiUrl,
+        configWhenGranted: options.configWhenGranted,
+        configWhenDenied: options.configWhenDenied,
+        scriptUrl: options.scriptUrl ?? 'https://cdn.databuddy.cc/databuddy.js'
+    });
+    return resolved;
 }
-export { databuddy };
+export { databuddy, databuddyManifest };

package/dist/engine/compile.cjs

@@ -0,0 +1,126 @@
+"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__, {
+    compileManifest: ()=>compileManifest,
+    interpolateValue: ()=>interpolateValue
+});
+const external_types_cjs_namespaceObject = require("../types.cjs");
+const EXACT_PLACEHOLDER_PATTERN = /^\{\{([A-Za-z0-9_]+)\}\}$/;
+const PLACEHOLDER_PATTERN = /\{\{([A-Za-z0-9_]+)\}\}/g;
+function getConfigValue(config, key) {
+    if (!(key in config)) throw new Error(`Missing manifest interpolation value for '${key}'.`);
+    const value = config[key];
+    if ('function' == typeof value) throw new Error(`Manifest interpolation value for '${key}' must be serializable.`);
+    return value;
+}
+function stringifyInterpolatedValue(value, key) {
+    if (void 0 === value) throw new Error(`Missing manifest interpolation value for '${key}'.`);
+    if ('string' == typeof value) return value;
+    if (null === value) return 'null';
+    if ('object' == typeof value) return JSON.stringify(value);
+    return String(value);
+}
+function interpolateString(template, config) {
+    const exactMatch = template.match(EXACT_PLACEHOLDER_PATTERN);
+    if (exactMatch) return getConfigValue(config, exactMatch[1]);
+    return template.replace(PLACEHOLDER_PATTERN, (_match, key)=>{
+        const value = getConfigValue(config, key);
+        return stringifyInterpolatedValue(value, key);
+    });
+}
+function interpolateValue(value, config) {
+    if ('string' == typeof value) return interpolateString(value, config);
+    if (Array.isArray(value)) return value.map((item)=>interpolateValue(item, config));
+    if (null !== value && 'object' == typeof value) {
+        const result = {};
+        for (const [key, nestedValue] of Object.entries(value)){
+            const interpolated = interpolateValue(nestedValue, config);
+            if (void 0 !== interpolated) result[key] = interpolated;
+        }
+        return result;
+    }
+    return value;
+}
+function interpolateSteps(steps, config) {
+    if (!steps) return [];
+    return steps.map((step)=>interpolateValue(step, config));
+}
+function extractInstallArtifacts(install) {
+    const loadScriptSteps = install.filter((step)=>'loadScript' === step.type);
+    if (loadScriptSteps.length > 1) throw new Error('Vendor manifests may only declare a single loadScript step in install.');
+    if (1 === loadScriptSteps.length) {
+        const loadScript = loadScriptSteps[0];
+        if ('string' != typeof loadScript.src || 0 === loadScript.src.trim().length) throw new Error('loadScript steps must include a non-empty src after manifest interpolation.');
+        return {
+            loadScript,
+            setupSteps: install.filter((step)=>'loadScript' !== step.type)
+        };
+    }
+    return {
+        setupSteps: install
+    };
+}
+function validateManifestContract(manifest) {
+    if (manifest.kind !== external_types_cjs_namespaceObject.VENDOR_MANIFEST_KIND) throw new Error(`Unsupported manifest kind '${String(manifest.kind)}'. Expected '${external_types_cjs_namespaceObject.VENDOR_MANIFEST_KIND}'.`);
+    if (manifest.schemaVersion !== external_types_cjs_namespaceObject.VENDOR_MANIFEST_SCHEMA_VERSION) throw new Error(`Unsupported manifest schema version '${String(manifest.schemaVersion)}'. Expected '${external_types_cjs_namespaceObject.VENDOR_MANIFEST_SCHEMA_VERSION}'.`);
+}
+function compileManifest(manifest, config = {}) {
+    validateManifestContract(manifest);
+    const bootstrapSteps = interpolateSteps(manifest.bootstrap, config);
+    const install = interpolateSteps(manifest.install, config);
+    const { loadScript, setupSteps } = extractInstallArtifacts(install);
+    return {
+        kind: manifest.kind,
+        schemaVersion: manifest.schemaVersion,
+        vendor: manifest.vendor,
+        category: interpolateValue(manifest.category, config),
+        alwaysLoad: void 0 === manifest.alwaysLoad ? void 0 : interpolateValue(manifest.alwaysLoad, config),
+        persistAfterConsentRevoked: void 0 === manifest.persistAfterConsentRevoked ? void 0 : interpolateValue(manifest.persistAfterConsentRevoked, config),
+        bootstrapSteps,
+        setupSteps,
+        loadScript,
+        afterLoadSteps: interpolateSteps(manifest.afterLoad, config),
+        onBeforeLoadGrantedSteps: interpolateSteps(manifest.onBeforeLoadGranted, config),
+        onBeforeLoadDeniedSteps: interpolateSteps(manifest.onBeforeLoadDenied, config),
+        onLoadGrantedSteps: interpolateSteps(manifest.onLoadGranted, config),
+        onLoadDeniedSteps: interpolateSteps(manifest.onLoadDenied, config),
+        onConsentChangeSteps: interpolateSteps(manifest.onConsentChange, config),
+        onConsentGrantedSteps: interpolateSteps(manifest.onConsentGranted, config),
+        onConsentDeniedSteps: interpolateSteps(manifest.onConsentDenied, config),
+        consentMapping: manifest.consentMapping ? interpolateValue(manifest.consentMapping, config) : void 0,
+        consentSignal: manifest.consentSignal,
+        consentSignalTarget: 'string' == typeof manifest.consentSignalTarget ? interpolateValue(manifest.consentSignalTarget, config) : manifest.consentSignalTarget
+    };
+}
+exports.compileManifest = __webpack_exports__.compileManifest;
+exports.interpolateValue = __webpack_exports__.interpolateValue;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "compileManifest",
+    "interpolateValue"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/engine/compile.js

@@ -0,0 +1,89 @@
+import { VENDOR_MANIFEST_KIND, VENDOR_MANIFEST_SCHEMA_VERSION } from "../types.js";
+const EXACT_PLACEHOLDER_PATTERN = /^\{\{([A-Za-z0-9_]+)\}\}$/;
+const PLACEHOLDER_PATTERN = /\{\{([A-Za-z0-9_]+)\}\}/g;
+function getConfigValue(config, key) {
+    if (!(key in config)) throw new Error(`Missing manifest interpolation value for '${key}'.`);
+    const value = config[key];
+    if ('function' == typeof value) throw new Error(`Manifest interpolation value for '${key}' must be serializable.`);
+    return value;
+}
+function stringifyInterpolatedValue(value, key) {
+    if (void 0 === value) throw new Error(`Missing manifest interpolation value for '${key}'.`);
+    if ('string' == typeof value) return value;
+    if (null === value) return 'null';
+    if ('object' == typeof value) return JSON.stringify(value);
+    return String(value);
+}
+function interpolateString(template, config) {
+    const exactMatch = template.match(EXACT_PLACEHOLDER_PATTERN);
+    if (exactMatch) return getConfigValue(config, exactMatch[1]);
+    return template.replace(PLACEHOLDER_PATTERN, (_match, key)=>{
+        const value = getConfigValue(config, key);
+        return stringifyInterpolatedValue(value, key);
+    });
+}
+function interpolateValue(value, config) {
+    if ('string' == typeof value) return interpolateString(value, config);
+    if (Array.isArray(value)) return value.map((item)=>interpolateValue(item, config));
+    if (null !== value && 'object' == typeof value) {
+        const result = {};
+        for (const [key, nestedValue] of Object.entries(value)){
+            const interpolated = interpolateValue(nestedValue, config);
+            if (void 0 !== interpolated) result[key] = interpolated;
+        }
+        return result;
+    }
+    return value;
+}
+function interpolateSteps(steps, config) {
+    if (!steps) return [];
+    return steps.map((step)=>interpolateValue(step, config));
+}
+function extractInstallArtifacts(install) {
+    const loadScriptSteps = install.filter((step)=>'loadScript' === step.type);
+    if (loadScriptSteps.length > 1) throw new Error('Vendor manifests may only declare a single loadScript step in install.');
+    if (1 === loadScriptSteps.length) {
+        const loadScript = loadScriptSteps[0];
+        if ('string' != typeof loadScript.src || 0 === loadScript.src.trim().length) throw new Error('loadScript steps must include a non-empty src after manifest interpolation.');
+        return {
+            loadScript,
+            setupSteps: install.filter((step)=>'loadScript' !== step.type)
+        };
+    }
+    return {
+        setupSteps: install
+    };
+}
+function validateManifestContract(manifest) {
+    if (manifest.kind !== VENDOR_MANIFEST_KIND) throw new Error(`Unsupported manifest kind '${String(manifest.kind)}'. Expected '${VENDOR_MANIFEST_KIND}'.`);
+    if (manifest.schemaVersion !== VENDOR_MANIFEST_SCHEMA_VERSION) throw new Error(`Unsupported manifest schema version '${String(manifest.schemaVersion)}'. Expected '${VENDOR_MANIFEST_SCHEMA_VERSION}'.`);
+}
+function compileManifest(manifest, config = {}) {
+    validateManifestContract(manifest);
+    const bootstrapSteps = interpolateSteps(manifest.bootstrap, config);
+    const install = interpolateSteps(manifest.install, config);
+    const { loadScript, setupSteps } = extractInstallArtifacts(install);
+    return {
+        kind: manifest.kind,
+        schemaVersion: manifest.schemaVersion,
+        vendor: manifest.vendor,
+        category: interpolateValue(manifest.category, config),
+        alwaysLoad: void 0 === manifest.alwaysLoad ? void 0 : interpolateValue(manifest.alwaysLoad, config),
+        persistAfterConsentRevoked: void 0 === manifest.persistAfterConsentRevoked ? void 0 : interpolateValue(manifest.persistAfterConsentRevoked, config),
+        bootstrapSteps,
+        setupSteps,
+        loadScript,
+        afterLoadSteps: interpolateSteps(manifest.afterLoad, config),
+        onBeforeLoadGrantedSteps: interpolateSteps(manifest.onBeforeLoadGranted, config),
+        onBeforeLoadDeniedSteps: interpolateSteps(manifest.onBeforeLoadDenied, config),
+        onLoadGrantedSteps: interpolateSteps(manifest.onLoadGranted, config),
+        onLoadDeniedSteps: interpolateSteps(manifest.onLoadDenied, config),
+        onConsentChangeSteps: interpolateSteps(manifest.onConsentChange, config),
+        onConsentGrantedSteps: interpolateSteps(manifest.onConsentGranted, config),
+        onConsentDeniedSteps: interpolateSteps(manifest.onConsentDenied, config),
+        consentMapping: manifest.consentMapping ? interpolateValue(manifest.consentMapping, config) : void 0,
+        consentSignal: manifest.consentSignal,
+        consentSignalTarget: 'string' == typeof manifest.consentSignalTarget ? interpolateValue(manifest.consentSignalTarget, config) : manifest.consentSignalTarget
+    };
+}
+export { compileManifest, interpolateValue };