@builder.io/sdk 3.0.6 → 3.0.8

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @builder.io/sdk
 
+## 3.0.8
+
+### Patch Changes
+
+- af26e42: Fix: Restrict event listening to when `isEditing === true`
+- 00d8154: Fix: increase coverage of `trustedHost` check to all messages.
+
+## 3.0.7
+
+### Patch Changes
+
+- bfe9d7e: Misc: send SDK headers in API requests ( https://github.com/BuilderIO/builder/pull/3659 )
+
 ## 3.0.6
 
 ### Patch Changes

package/dist/index.browser.js

@@ -1052,7 +1052,7 @@
 
     var DEFAULT_API_VERSION = 'v3';
 
-    var SDK_VERSION = '3.0.6';
+    var SDK_VERSION = 'UNKNOWN_VERSION_TO_REPLACE';
 
     function datePlusMinutes(minutes) {
         if (minutes === void 0) { minutes = 30; }
@@ -1247,8 +1247,8 @@
                 this.authToken = authToken;
             }
             if (isBrowser) {
-                this.bindMessageListeners();
                 if (Builder.isEditing) {
+                    this.bindMessageListeners();
                     parent.postMessage({
                         type: 'builder.animatorOptions',
                         data: {
@@ -1379,11 +1379,16 @@
             this.serverContext = context;
         };
         Builder.isTrustedHost = function (hostname) {
-            return (this.trustedHosts.findIndex(function (trustedHost) {
+            var isTrusted = this.trustedHosts.findIndex(function (trustedHost) {
                 return trustedHost.startsWith('*.')
                     ? hostname.endsWith(trustedHost.slice(1))
                     : trustedHost === hostname;
-            }) > -1);
+            }) > -1;
+            return isTrusted;
+        };
+        Builder.isTrustedHostForEvent = function (event) {
+            var url = parse(event.origin);
+            return url.hostname && Builder.isTrustedHost(url.hostname);
         };
         Builder.runAction = function (action) {
             // TODO
@@ -1542,9 +1547,7 @@
             getFetch()("".concat(host, "/api/v1/track"), {
                 method: 'POST',
                 body: JSON.stringify({ events: events }),
-                headers: {
-                    'content-type': 'application/json',
-                },
+                headers: __assign({ 'content-type': 'application/json' }, this.getSdkHeaders()),
                 mode: 'cors',
             }).catch(function () {
                 // Not the end of the world
@@ -1933,184 +1936,179 @@
         };
         Builder.prototype.bindMessageListeners = function () {
             var _this = this;
-            if (isBrowser) {
-                addEventListener('message', function (event) {
-                    var _a, _b, _c, _d, _e;
-                    var url = parse(event.origin);
-                    var isRestricted = ['builder.register', 'builder.registerComponent'].indexOf((_a = event.data) === null || _a === void 0 ? void 0 : _a.type) === -1;
-                    var isTrusted = url.hostname && Builder.isTrustedHost(url.hostname);
-                    if (isRestricted && !isTrusted) {
-                        return;
-                    }
-                    var data = event.data;
-                    if (data) {
-                        switch (data.type) {
-                            case 'builder.ping': {
-                                (_b = window.parent) === null || _b === void 0 ? void 0 : _b.postMessage({
-                                    type: 'builder.pong',
-                                    data: {},
-                                }, '*');
+            addEventListener('message', function (event) {
+                var _a, _b, _c, _d;
+                var isTrusted = Builder.isTrustedHostForEvent(event);
+                if (!isTrusted)
+                    return;
+                var data = event.data;
+                if (data) {
+                    switch (data.type) {
+                        case 'builder.ping': {
+                            (_a = window.parent) === null || _a === void 0 ? void 0 : _a.postMessage({
+                                type: 'builder.pong',
+                                data: {},
+                            }, '*');
+                            break;
+                        }
+                        case 'builder.register': {
+                            // TODO: possibly do this for all...
+                            if (event.source === window) {
                                 break;
                             }
-                            case 'builder.register': {
-                                // TODO: possibly do this for all...
-                                if (event.source === window) {
-                                    break;
-                                }
-                                var options = data.data;
-                                if (!options) {
-                                    break;
-                                }
-                                var type = options.type, info = options.info;
-                                // TODO: all must have name and can't conflict?
-                                var typeList = Builder.registry[type];
-                                if (!typeList) {
-                                    typeList = Builder.registry[type] = [];
-                                }
-                                typeList.push(info);
-                                Builder.registryChange.next(Builder.registry);
+                            var options = data.data;
+                            if (!options) {
                                 break;
                             }
-                            case 'builder.settingsChange': {
-                                // TODO: possibly do this for all...
-                                if (event.source === window) {
-                                    break;
-                                }
-                                var settings = data.data;
-                                if (!settings) {
-                                    break;
-                                }
-                                Object.assign(Builder.settings, settings);
-                                Builder.settingsChange.next(Builder.settings);
+                            var type = options.type, info = options.info;
+                            // TODO: all must have name and can't conflict?
+                            var typeList = Builder.registry[type];
+                            if (!typeList) {
+                                typeList = Builder.registry[type] = [];
+                            }
+                            typeList.push(info);
+                            Builder.registryChange.next(Builder.registry);
+                            break;
+                        }
+                        case 'builder.settingsChange': {
+                            // TODO: possibly do this for all...
+                            if (event.source === window) {
                                 break;
                             }
-                            case 'builder.registerEditor': {
-                                // TODO: possibly do this for all...
-                                if (event.source === window) {
-                                    break;
-                                }
-                                var info_1 = data.data;
-                                if (!info_1) {
-                                    break;
-                                }
-                                var hasComponent_1 = !!info_1.component;
-                                Builder.editors.every(function (thisInfo, index) {
-                                    if (info_1.name === thisInfo.name) {
-                                        if (thisInfo.component && !hasComponent_1) {
-                                            return false;
-                                        }
-                                        else {
-                                            Builder.editors[index] = thisInfo;
-                                        }
-                                        return false;
-                                    }
-                                    return true;
-                                });
+                            var settings = data.data;
+                            if (!settings) {
                                 break;
                             }
-                            case 'builder.triggerAnimation': {
-                                Builder.animator.triggerAnimation(data.data);
+                            Object.assign(Builder.settings, settings);
+                            Builder.settingsChange.next(Builder.settings);
+                            break;
+                        }
+                        case 'builder.registerEditor': {
+                            // TODO: possibly do this for all...
+                            if (event.source === window) {
                                 break;
                             }
-                            case 'builder.contentUpdate':
-                                var key = data.data.key || data.data.alias || data.data.entry || data.data.modelName;
-                                var contentData = data.data.data; // hmmm...
-                                var observer = _this.observersByKey[key];
-                                if (observer && !_this.noEditorUpdates[key]) {
-                                    observer.next([contentData]);
-                                }
+                            var info_1 = data.data;
+                            if (!info_1) {
                                 break;
-                            case 'builder.getComponents':
+                            }
+                            var hasComponent_1 = !!info_1.component;
+                            Builder.editors.every(function (thisInfo, index) {
+                                if (info_1.name === thisInfo.name) {
+                                    if (thisInfo.component && !hasComponent_1) {
+                                        return false;
+                                    }
+                                    else {
+                                        Builder.editors[index] = thisInfo;
+                                    }
+                                    return false;
+                                }
+                                return true;
+                            });
+                            break;
+                        }
+                        case 'builder.triggerAnimation': {
+                            Builder.animator.triggerAnimation(data.data);
+                            break;
+                        }
+                        case 'builder.contentUpdate':
+                            var key = data.data.key || data.data.alias || data.data.entry || data.data.modelName;
+                            var contentData = data.data.data; // hmmm...
+                            var observer = _this.observersByKey[key];
+                            if (observer && !_this.noEditorUpdates[key]) {
+                                observer.next([contentData]);
+                            }
+                            break;
+                        case 'builder.getComponents':
+                            (_b = window.parent) === null || _b === void 0 ? void 0 : _b.postMessage({
+                                type: 'builder.components',
+                                data: Builder.components.map(function (item) { return Builder.prepareComponentSpecToSend(item); }),
+                            }, '*');
+                            break;
+                        case 'builder.editingModel':
+                            _this.editingModel = data.data.model;
+                            break;
+                        case 'builder.registerComponent':
+                            var componentData = data.data;
+                            Builder.addComponent(componentData);
+                            break;
+                        case 'builder.blockContentLoading':
+                            if (typeof data.data.model === 'string') {
+                                _this.blockContentLoading = data.data.model;
+                            }
+                            break;
+                        case 'builder.editingMode':
+                            var editingMode = data.data;
+                            if (editingMode) {
+                                _this.editingMode = true;
+                                document.body.classList.add('builder-editing');
+                            }
+                            else {
+                                _this.editingMode = false;
+                                document.body.classList.remove('builder-editing');
+                            }
+                            break;
+                        case 'builder.editingPageMode':
+                            var editingPageMode = data.data;
+                            Builder.editingPage = editingPageMode;
+                            break;
+                        case 'builder.overrideUserAttributes':
+                            var userAttributes = data.data;
+                            assign(Builder.overrideUserAttributes, userAttributes);
+                            _this.flushGetContentQueue(true);
+                            // TODO: refetch too
+                            break;
+                        case 'builder.overrideTestGroup':
+                            var _e = data.data, variationId = _e.variationId, contentId = _e.contentId;
+                            if (variationId && contentId) {
+                                _this.setTestCookie(contentId, variationId);
+                                _this.flushGetContentQueue(true);
+                            }
+                            break;
+                        case 'builder.evaluate': {
+                            var text = data.data.text;
+                            var args = data.data.arguments || [];
+                            var id_1 = data.data.id;
+                            // tslint:disable-next-line:no-function-constructor-with-string-args
+                            var fn = new Function(text);
+                            var result = void 0;
+                            var error = null;
+                            try {
+                                result = fn.apply(_this, args);
+                            }
+                            catch (err) {
+                                error = toError(err);
+                            }
+                            if (error) {
                                 (_c = window.parent) === null || _c === void 0 ? void 0 : _c.postMessage({
-                                    type: 'builder.components',
-                                    data: Builder.components.map(function (item) { return Builder.prepareComponentSpecToSend(item); }),
+                                    type: 'builder.evaluateError',
+                                    data: { id: id_1, error: error.message },
                                 }, '*');
-                                break;
-                            case 'builder.editingModel':
-                                _this.editingModel = data.data.model;
-                                break;
-                            case 'builder.registerComponent':
-                                var componentData = data.data;
-                                Builder.addComponent(componentData);
-                                break;
-                            case 'builder.blockContentLoading':
-                                if (typeof data.data.model === 'string') {
-                                    _this.blockContentLoading = data.data.model;
-                                }
-                                break;
-                            case 'builder.editingMode':
-                                var editingMode = data.data;
-                                if (editingMode) {
-                                    _this.editingMode = true;
-                                    document.body.classList.add('builder-editing');
+                            }
+                            else {
+                                if (result && typeof result.then === 'function') {
+                                    result
+                                        .then(function (finalResult) {
+                                        var _a;
+                                        (_a = window.parent) === null || _a === void 0 ? void 0 : _a.postMessage({
+                                            type: 'builder.evaluateResult',
+                                            data: { id: id_1, result: finalResult },
+                                        }, '*');
+                                    })
+                                        .catch(console.error);
                                 }
                                 else {
-                                    _this.editingMode = false;
-                                    document.body.classList.remove('builder-editing');
-                                }
-                                break;
-                            case 'builder.editingPageMode':
-                                var editingPageMode = data.data;
-                                Builder.editingPage = editingPageMode;
-                                break;
-                            case 'builder.overrideUserAttributes':
-                                var userAttributes = data.data;
-                                assign(Builder.overrideUserAttributes, userAttributes);
-                                _this.flushGetContentQueue(true);
-                                // TODO: refetch too
-                                break;
-                            case 'builder.overrideTestGroup':
-                                var _f = data.data, variationId = _f.variationId, contentId = _f.contentId;
-                                if (variationId && contentId) {
-                                    _this.setTestCookie(contentId, variationId);
-                                    _this.flushGetContentQueue(true);
-                                }
-                                break;
-                            case 'builder.evaluate': {
-                                var text = data.data.text;
-                                var args = data.data.arguments || [];
-                                var id_1 = data.data.id;
-                                // tslint:disable-next-line:no-function-constructor-with-string-args
-                                var fn = new Function(text);
-                                var result = void 0;
-                                var error = null;
-                                try {
-                                    result = fn.apply(_this, args);
-                                }
-                                catch (err) {
-                                    error = toError(err);
-                                }
-                                if (error) {
                                     (_d = window.parent) === null || _d === void 0 ? void 0 : _d.postMessage({
-                                        type: 'builder.evaluateError',
-                                        data: { id: id_1, error: error.message },
+                                        type: 'builder.evaluateResult',
+                                        data: { result: result, id: id_1 },
                                     }, '*');
                                 }
-                                else {
-                                    if (result && typeof result.then === 'function') {
-                                        result
-                                            .then(function (finalResult) {
-                                            var _a;
-                                            (_a = window.parent) === null || _a === void 0 ? void 0 : _a.postMessage({
-                                                type: 'builder.evaluateResult',
-                                                data: { id: id_1, result: finalResult },
-                                            }, '*');
-                                        })
-                                            .catch(console.error);
-                                    }
-                                    else {
-                                        (_e = window.parent) === null || _e === void 0 ? void 0 : _e.postMessage({
-                                            type: 'builder.evaluateResult',
-                                            data: { result: result, id: id_1 },
-                                        }, '*');
-                                    }
-                                }
-                                break;
                             }
+                            break;
                         }
                     }
-                });
-            }
+                }
+            });
         };
         Object.defineProperty(Builder.prototype, "defaultCanTrack", {
             get: function () {
@@ -2343,7 +2341,7 @@
         // even though we only use `fetch()` now, we prefer to keep the old behavior and use the `fetch` that comes from
         // the core SDK for consistency
         Builder.prototype.requestUrl = function (url, options) {
-            return getFetch()(url, options).then(function (res) { return res.json(); });
+            return getFetch()(url, this.addSdkHeaders(options)).then(function (res) { return res.json(); });
         };
         Object.defineProperty(Builder.prototype, "host", {
             get: function () {
@@ -2372,8 +2370,21 @@
             enumerable: false,
             configurable: true
         });
+        Builder.prototype.getSdkHeaders = function () {
+            if (!Builder.sdkInfo) {
+                return {};
+            }
+            return {
+                'X-Builder-SDK': Builder.sdkInfo.name,
+                'X-Builder-SDK-GEN': '1',
+                'X-Builder-SDK-Version': Builder.sdkInfo.version,
+            };
+        };
+        Builder.prototype.addSdkHeaders = function (fetchOptions) {
+            return __assign(__assign({}, fetchOptions), { headers: __assign(__assign({}, fetchOptions.headers), this.getSdkHeaders()) });
+        };
         Builder.prototype.makeFetchApiCall = function (url, requestOptions) {
-            return getFetch()(url, requestOptions);
+            return getFetch()(url, this.addSdkHeaders(requestOptions));
         };
         Builder.prototype.flattenMongoQuery = function (obj, _current, _res) {
             if (_res === void 0) { _res = {}; }
@@ -2772,6 +2783,7 @@
             (location.search.indexOf('builder.preview=') !== -1 ||
                 location.search.indexOf('builder.frameEditing=') !== -1));
         Builder.isReact = false;
+        Builder.sdkInfo = undefined;
         Builder.overrideUserAttributes = {};
         return Builder;
     }());