@competitionlabs/gamification-widget-loader 1.0.1 → 1.0.2

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@competitionlabs/gamification-widget-loader",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "type": "module",
   "main": "dist/loader.js",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "dev": "vite --open /example/index.html",
     "build": "vite build",
-    "publish": "npm run build && npm publish --access restricted",
+    "publish:restricted": "npm run build && npm publish --access restricted",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],

package/ajax.js

@@ -1,65 +0,0 @@
-export const createAjaxClass = function ({ sizeof }) {
-    return class Ajax {
-        constructor() {
-            this.xhr = new XMLHttpRequest();
-        }
-
-        /* eslint no-undef: "off" */
-        createCORSRequest(method, url) {
-            if ('withCredentials' in this.xhr) {
-                /* Most browsers. */ this.xhr.open(method, url, true);
-            } else if (typeof XDomainRequest !== 'undefined') {
-                /* IE8 & IE9 */ this.xhr = new XDomainRequest();
-                url = url.indexOf('https') > -1 && location.protocol !== 'https:' ? url.replace('https', 'http') : url;
-                this.xhr.open(method, url);
-            } else {
-                /* CORS not supported. */ this.xhr = null;
-            }
-            return this.xhr;
-        }
-
-        abort() {
-            if (this.xhr && this.xhr.readyState !== undefined && this.xhr.readyState !== 4) {
-                this.xhr.abort();
-            }
-            return this;
-        }
-
-        /**
-         * Retrieves data from a URL without a page refresh.
-         */
-        getData(data) {
-            const obj = this;
-            try {
-                data.type = data.type !== undefined && typeof data.type === 'string' && data.type.length > 0 ? data.type : 'POST';
-                data.data = data.data !== undefined && typeof data.data === 'object' ? data.data : {};
-                data.url = data.url !== undefined && typeof data.url === 'string' && data.url.length > 0 ? data.url : '';
-                data.success = data.success !== undefined ? data.success : function () {};
-                data.error = data.error !== undefined ? data.error : function () {};
-                data.headers = data.headers !== undefined ? data.headers : {};
-                data.extraCallback = data.extraCallback !== undefined ? data.extraCallback : function () {};
-                obj.xhr = this.createCORSRequest(data.type, data.url);
-                obj.xhr.onload = function () {
-                    data.extraCallback(data, obj.xhr);
-                    data.success(obj.xhr.responseText, data, obj.xhr);
-                };
-                obj.xhr.onerror = function () {
-                    data.error(obj.xhr.status);
-                };
-                if (typeof XDomainRequest === 'undefined') {
-                    if (sizeof(data.headers) > 0) {
-                        for (const item in data.headers) {
-                            obj.xhr.setRequestHeader(item, data.headers[item]);
-                        }
-                    } else if ((data.type === 'POST' || data.type === 'PUT' || data.type === 'DELETE') && sizeof(data.headers) === 0) {
-                        obj.xhr.setRequestHeader('Content-Type', 'application/json');
-                    } else {
-                        obj.xhr.setRequestHeader('Content-Type', 'text/plain');
-                    }
-                }
-                obj.xhr.send(JSON.stringify(data.data));
-                return obj.xhr;
-            } catch {}
-        }
-    };
-};

package/example/example.js

@@ -1,22 +0,0 @@
-const loader = window.clLoaderV3;
-loader.settings = {
-    ...loader.settings,
-    apiKey: '37de27fd1d6242f283e826034bd83a81',
-    spaceName: 'client_2',
-    memberId: 'fynniqABiZWyLxn9MTLM',
-    uri: {
-        ...loader.settings.uri,
-        gatewayDomain: 'http://192.168.91.30:9998',
-        gatewayWSDomain: 'ws://192.168.91.30:9998'
-    },
-    uomSymbol: '€',
-    bindContainer: document.querySelector('#widget'),
-    language: 'en',
-    widgetStatus: 'Live',
-    isWidgetMinimized: false,
-    resources: [
-        'https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'
-    ]
-};
-
-loader.init();

package/example/index.html

@@ -1,13 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>CompetitionLabs Widget Loader Example</title>
-</head>
-<body>
-    <div id="widget"></div>
-    <script type="module" src="../loader.js"></script>
-    <script type="module" src="/example/example.js"></script>
-</body>
-</html>

package/loader.js

@@ -1,182 +0,0 @@
-/*
- COMPETITION LABS LTD v1.0.0
- (c) 2026 Nathan Galea
- License: www.competitionlabs.com/terms-of-service
-
- Centralised loader script that is responsible for loading/handling all your product/environment specific scripts
- in one place. Allows better control over your vast product range, centralising all your business related configurations
- in one place:
- - load all your scripts/styles/configurations/presets from one script
- - control when and how the scripts get initialised
- - restrict loading per product
-*/
-import sizeof from './sizeof.js';
-import { createAjaxClass } from './ajax.js';
-
-(function () {
-    'use strict';
-
-    const Ajax = createAjaxClass({ sizeof });
-
-    var loadScript = function () {
-        this.ajax = new Ajax();
-        this.settings = {
-            apiKey: '', // default API key
-            spaceName: 'my_space_name', // default space name
-            enforceGameLookup: true, // default enforce game lookup
-            language: 'en', // default language setting
-            currency: '', // default currency setting
-            enableNotifications: false, // requires a working/valid SSE channel
-            memberId: '',
-            uri: {
-                gatewayDomain: '',
-                gatewayWSDomain: '',
-                translationPath: '',
-                widgetData: '/api/v1/:space/widget'
-            },
-            uomSymbol: '',
-            isWidgetMinimized: true,
-            bindContainer: null,
-            miniBindContainer: null,
-            loadTranslationsForceCustomPath: true,
-            widgetStatus: 'Live',
-            resources: [],
-            assetsBasePath: '/build'
-        };
-
-        this.initialiseWidget = function (widgetData) {
-            const _this = this;
-            console.log('initialiseWidget', widgetData);
-
-            const widget = {
-                ...widgetData.data[0],
-                widgets: {
-                    type_1: {
-                        script: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/default/javascript/gamification-ux-package.v3-selfinit.js",
-                        css: ["https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/default/css/styles.css"],
-                        translations: {
-                            ja: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/default/i18n/translation_ja.json",
-                            en: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/default/i18n/translation_en.json"
-                        }
-                    },
-                    type_2: {
-                        script: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/type_2/javascript/gamification-ux-package.v3-selfinit.js",
-                        css: ["https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/type_2/css/styles.css"],
-                        translations: {
-                            ja: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/type_2/i18n/translation_ja.json",
-                            en: "https://s3.eu-west-1.amazonaws.com/demo.gamify.mt/gamification-widget/competitionlabs-gamification-widget-v3/themes/type_2/i18n/translation_en.json"
-                        }
-                    },
-                }
-            };
-
-            console.log('MY WIDGET DATA', widget)
-            const widgetType = widget.layout.toLowerCase();
-            const widgetAssets = widget.widgets?.[widgetType];
-
-            if (!widgetAssets) {
-                throw new Error(`CompetitionLabs widget configuration does not contain assets for ${widget.layout}`);
-            }
-
-            const translationPath = widgetAssets.translations?.[_this.settings.language] ||  widgetAssets.translations?.en || '';
-            const stylesheets = Array.isArray(widgetAssets.css) ? widgetAssets.css : [];
-
-            stylesheets.forEach(function (stylesheet) {
-                const isAlreadyLoaded = Array.from(document.head.querySelectorAll('link[rel="stylesheet"]'))
-                    .some((link) => link.href === new URL(stylesheet, document.baseURI).href);
-
-                if (!isAlreadyLoaded) {
-                    const link = document.createElement('link');
-                    link.rel = 'stylesheet';
-                    link.href = stylesheet;
-                    document.head.appendChild(link);
-                }
-            });
-
-            const widgetInstanceData = {
-                enableNotifications: _this.settings.enableNotifications,
-                memberId: _this.settings.memberId,
-                uri: {
-                    ..._this.settings.uri,
-                    translationPath
-                },
-                uomSymbol: _this.settings.uomSymbol,
-                spaceName: _this.settings.spaceName,
-                apiKey: _this.settings.apiKey,
-                isWidgetMinimized: _this.settings.isWidgetMinimized,
-                bindContainer: _this.settings.bindContainer,
-                miniBindContainer: _this.settings.miniBindContainer,
-                language: _this.settings.language,
-                loadTranslationsForceCustomPath: _this.settings.loadTranslationsForceCustomPath,
-                resources: [..._this.settings.resources],
-                widgetStatus: _this.settings.widgetStatus,
-                widgetData: Array.isArray(widgetData?.data) ? widgetData.data : [widget]
-            };
-            const initialise = function () {
-                if (typeof window._clWidgetV32026SelfInit !== 'function') {
-                    throw new Error('CompetitionLabs widget script did not create window._clWidgetV32026SelfInit');
-                }
-
-                window._clWidgetV32026 = new window._clWidgetV32026SelfInit({
-                    ...widgetInstanceData
-                });
-            };
-
-            if (!widgetAssets.script) {
-                throw new Error(`CompetitionLabs widget configuration does not contain a script for ${widget.layout}`);
-            }
-
-            if (typeof window._clWidgetV32026SelfInit !== 'undefined') {
-                initialise();
-
-            }else {
-                const script = document.createElement('script');
-                script.type = 'text/javascript';
-                script.src = widgetAssets.script;
-                script.onload = function () {
-                    initialise();
-                };
-                script.onerror = function () {
-                    throw new Error(`CompetitionLabs widget script failed to load: ${widgetAssets.script}`);
-                };
-                document.body.appendChild(script);
-            }
-
-        };
-
-        this.getWidgetData = function (callback) {
-            const _this = this;
-            const widgetDataUrl = `${_this.settings.uri.gatewayDomain}${_this.settings.uri.widgetData.replace(':space', _this.settings.spaceName)}?status=${_this.settings.widgetStatus}`;
-            _this.ajax.abort().getData({
-                type: 'GET',
-                url: widgetDataUrl,
-                headers: {
-                    'X-API-KEY': _this.settings.apiKey
-                },
-                success: function (response, dataObj, xhr) {
-                    if (xhr.status === 200) {
-                        const json = JSON.parse(response);
-                        _this.initialiseWidget(json);
-                        if (typeof callback === 'function') {
-                            callback(json);
-                        }
-                    }
-                },
-                error: function () {
-                    if (typeof callback === 'function') {
-                        callback();
-                    }
-                }
-            });
-        };
-
-        this.init = function (callback) {
-            const _this = this;
-            console.log('Initting Data')
-            _this.getWidgetData(callback);
-        };
-    };
-
-    /* eslint new-cap: "off" */
-    window.clLoaderV3 = new loadScript();
-})();

package/sizeof.js

@@ -1,27 +0,0 @@
-const isElement = function (value) {
-    return typeof Element !== 'undefined' && value instanceof Element;
-};
-
-/**
- * returns the size of an Object or array
- *
- * @memberOf module:utils
- * @static
- * @param obj {Object}
- * @return {Number}
- */
-const sizeof = function (obj) {
-    let size = 0;
-    let key;
-    for (key in obj) {
-        if (obj.hasOwnProperty(key)) size++;
-    }
-
-    if (size === 0 && isElement(obj)) {
-        size = 1;
-    }
-
-    return size;
-};
-
-export default sizeof;

package/vite.config.js

@@ -1,12 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-    build: {
-        lib: {
-            entry: 'loader.js',
-            name: 'CompetitionLabsWidgetLoader',
-            formats: ['iife'],
-            fileName: () => 'loader.js'
-        }
-    }
-});