feature-toggle-api 3.4.2 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +129 -103
  2. package/dist/feature-toggle.d.ts +134 -0
  3. package/{src/index.js → dist/feature-toggle.js} +193 -114
  4. package/dist/feature-toggle.min.cjs +2 -0
  5. package/dist/feature-toggle.min.cjs.map +1 -0
  6. package/dist/feature-toggle.min.js +2 -0
  7. package/dist/feature-toggle.min.js.map +1 -0
  8. package/dist/feature-toggle.umd.min.js +2 -0
  9. package/dist/feature-toggle.umd.min.js.map +1 -0
  10. package/dist/html-plugin.umd.min.js +2 -0
  11. package/dist/html-plugin.umd.min.js.map +1 -0
  12. package/dist/url-plugin.umd.min.js +2 -0
  13. package/dist/url-plugin.umd.min.js.map +1 -0
  14. package/examples/01_basic_esmodule.js +10 -0
  15. package/examples/02_basic_cjsmodule.cjs +6 -0
  16. package/examples/{basic.html → 03_basic_scripttag.html} +3 -2
  17. package/examples/{example-htmlplugin.html → 04_example-htmlplugin.html} +2 -2
  18. package/examples/{example-urlplugin.html → 05_example-urlplugin.html} +2 -2
  19. package/examples/{withListener.html → 06_withListener.html} +1 -1
  20. package/package.json +32 -43
  21. package/rollup.config.js +107 -0
  22. package/src/featureToggle.ts +466 -0
  23. package/src/index.ts +10 -0
  24. package/src/plugins/htmlplugin/{plugin-html.js → plugin-html.ts} +22 -10
  25. package/src/plugins/urlplugin/{plugin-url.js → plugin-url.ts} +36 -10
  26. package/tests/featuretoggle.test.ts +450 -0
  27. package/tests/polyfills.ts +20 -0
  28. package/tsconfig.cjs.json +12 -0
  29. package/tsconfig.json +12 -0
  30. package/feature-toggle-api.js +0 -243
  31. package/feature-toggle-api.min.js +0 -1
  32. package/feature-toggle-api.module.js +0 -243
  33. package/spec/support/index.spec.js +0 -378
  34. package/spec/support/jasmine.json +0 -11
  35. package/spec/support/polyfills.js +0 -6
  36. package/src/index.cjs.js +0 -8
@@ -1,243 +0,0 @@
1
- 'use strict';
2
-
3
- function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
4
- var parseToFn = function parseToFn(fnOrBool) {
5
- if (typeof fnOrBool == 'boolean') return function () {
6
- return fnOrBool;
7
- };
8
- return fnOrBool;
9
- };
10
- var getKey = function getKey(name, variant) {
11
- var _name = name.toLowerCase();
12
- if (typeof variant == 'string') {
13
- _name += "#" + variant.toLowerCase();
14
- }
15
- return _name;
16
- };
17
- function initVisibilities() {
18
- var visibilities = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
19
- var returnVisibilities = {};
20
- Object.keys(visibilities).forEach(function (key) {
21
- if (key.startsWith('_')) return;
22
- returnVisibilities[getKey(key)] = parseToFn(visibilities[key]);
23
- });
24
- return returnVisibilities;
25
- }
26
- function featuretoggleapi() {
27
- var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
28
- var globals = {
29
- datas: {},
30
- listeners: {},
31
- visibilities: initVisibilities(config),
32
- showLogs: false,
33
- usedPlugins: []
34
- };
35
- function init(api) {
36
- if (config._plugins) {
37
- if (!Array.isArray(config._plugins)) throw new Error('featuretoggleapi()-constructor: config.plugins must be an array.');
38
- config._plugins.forEach(function (plugin) {
39
- if (typeof plugin !== 'function') throw new Error('featuretoggleapi()-constructor: config.plugins needs functions as entries, not ' + _typeof(plugin) + '.');
40
- _addPlugin(plugin, api);
41
- });
42
- }
43
- triggerEvent('init');
44
- }
45
- function _addPlugin(plugin, api) {
46
- plugin(api);
47
- }
48
- function triggerEvent(eventtype, param) {
49
- (globals.listeners[eventtype] || []).forEach(function (listener) {
50
- listener(param);
51
- });
52
- }
53
- var log = function log(message) {
54
- if (!globals.showLogs) return;
55
-
56
- //Nur Browser können Syntaxhighlighting die anderen geben die Nachricht einfach aus und schneiden
57
- //die styletags raus
58
- if (typeof window === 'undefined') {
59
- var loggedMessage = message.replace(/<b>/g, "");
60
- console.log(loggedMessage);
61
- return;
62
- }
63
- var hasBoldTag = message.indexOf('<b>') != -1;
64
- var hasVisibleKeyword = message.indexOf('visible') != -1;
65
- var hasHiddenKeyword = message.indexOf('hidden') != -1;
66
- var _message = message.replace('visible', '%cvisible');
67
- _message = _message.replace('hidden', '%chidden');
68
- if (hasVisibleKeyword) console.log(_message, "color:green;font-weight:bold;");else if (hasHiddenKeyword) console.log(_message, "color:red;font-weight:bold;");else if (hasBoldTag) {
69
- _message = _message.replace('<b>', '%c');
70
- var parts = [_message, 'font-weight:bold;'];
71
- console.log.apply(null, parts);
72
- } else console.log(message);
73
- };
74
- var logAndReturn = function logAndReturn(returnValue, message) {
75
- log(message);
76
- log('');
77
- return returnValue;
78
- };
79
- var getVisibility = function getVisibility(visibilityFn, functionname, name, variant, data) {
80
- if (visibilityFn == null) return undefined;
81
- var calculatedVisibility = visibilityFn({
82
- name: name,
83
- variant: variant,
84
- data: data
85
- });
86
- if (typeof calculatedVisibility == 'boolean') {
87
- return calculatedVisibility;
88
- }
89
- return logAndReturn(false, "The ".concat(functionname, " returns ").concat(calculatedVisibility, ". => Please return true or false. This result (and all non-boolean results) will return false."));
90
- };
91
- function parseKey(key) {
92
- var parts = key.split('#');
93
- return {
94
- name: parts[0],
95
- variant: parts.length > 1 ? parts[1] : undefined,
96
- data: globals.datas[key]
97
- };
98
- }
99
-
100
- /*
101
- the following calls are possible:
102
- visibility(name,result);
103
- visibility(name,variant,result);
104
- visibility(name,variant,data,result);
105
-
106
- =>
107
- param1: name
108
- param2: result || variant
109
- param3: result || data
110
- param4: result
111
- */
112
- function visibilityFnParams(param1, param2, param3, param4) {
113
- //name must always be set
114
- if (param1 == undefined) throw new Error('feature.visibility(): 1st parameter name must be defined');
115
- if (arguments.length == 1) throw new Error('feature.visibility(): 2nd parameter name must be a boolean or function, but is empty');
116
- var name = param1,
117
- variant = null,
118
- data = null,
119
- result = null;
120
- if (param3 == undefined && param4 == undefined) {
121
- result = param2;
122
- } else if (param4 == undefined) {
123
- variant = param2;
124
- result = param3;
125
- } else {
126
- variant = param2;
127
- data = param3;
128
- result = param4;
129
- }
130
- return {
131
- name: name,
132
- variant: variant,
133
- data: data,
134
- result: result
135
- };
136
- }
137
- function getEvent(name, variant, data, result) {
138
- var event;
139
- event = {
140
- name: name,
141
- variant: variant,
142
- data: data
143
- };
144
- event.key = getKey(event.name, event.variant);
145
- if (result == null) return event;
146
- event.visibilityFunction = parseToFn(result);
147
- event.result = event.visibilityFunction({
148
- name: event.name,
149
- variant: event.variant,
150
- data: event.data || {},
151
- _internalCall: true,
152
- description: 'When attaching a function, the result must be calculated internally. You can filter this out with the _internalCall:true -Flag.'
153
- });
154
- return event;
155
- }
156
- function isVisible(name, variant, data) {
157
- var visibilities = globals.visibilities;
158
- log("\nCheck Visibility of <b>Feature \"".concat(name, "\", variant \"").concat(variant == undefined ? '' : variant, "\"").concat(data ? " with data " + JSON.stringify(data) : "", "."));
159
- if (name == undefined) throw new Error('The attribute "name" is required for tag <feature></feature>. Example: <feature name="aname"></feature>');
160
- var requiredFn = visibilities['_required'];
161
- var requiredFnExists = visibilities['_required'] != null;
162
- var requiredFnResult = getVisibility(requiredFn, 'requiredVisibility', name, variant, data);
163
- var visibilityFnKey = getKey(name, variant);
164
- var visibilityFn = visibilities[visibilityFnKey];
165
- var visibilityFnExists = visibilities[visibilityFnKey] != null;
166
- var visibilityFnResult = getVisibility(visibilityFn, 'visibility function', name, variant, data);
167
- var variantExists = variant != null;
168
- var visibilityOnlyNameFnKey = getKey(name, null);
169
- var visibilityOnlyNameFn = visibilities[visibilityOnlyNameFnKey];
170
- visibilities[visibilityOnlyNameFnKey] != null;
171
- var visibilityOnlyNameFnResult = getVisibility(visibilityOnlyNameFn, 'visibility function (only name)', name, variant, data);
172
- var defaultFn = visibilities['_default'];
173
- var defaultFnExists = visibilities['_default'] != null;
174
- var defaultFnResult = getVisibility(defaultFn, 'defaultVisibility', name, variant, data);
175
- if (!requiredFnExists) log("No requiredVisibility rule specified for this feature.");else if (requiredFnExists && requiredFnResult === true) log("The requiredVisibility rule returns true. This feature will be shown when no other rule rejects it.");else if (requiredFnExists && requiredFnResult === false) return logAndReturn(false, "The requiredVisibility rule returns false. This feature will be hidden.");
176
- if (visibilityFnExists) return logAndReturn(visibilityFnResult, "The visibility rule returns ".concat(visibilityFnResult, ". This feature will be ").concat(visibilityFnResult ? 'visible' : 'hidden', "."));
177
- log('No visibility rule found matching name and variant.');
178
- if (variantExists && typeof visibilityOnlyNameFnResult == 'boolean') return logAndReturn(visibilityOnlyNameFnResult, "Found a visibility rule for name ".concat(name, " without variants. The rule returns ").concat(visibilityOnlyNameFnResult, ". => This feature will be ").concat(visibilityOnlyNameFnResult ? 'visible' : 'hidden', "."));else if (variantExists) log("No rules found for name ".concat(name, " without variants."));
179
- if (defaultFnExists) return logAndReturn(defaultFnResult, "Found a defaultVisibility rule. The rule returns ".concat(defaultFnResult, ". => This feature will be ").concat(defaultFnResult ? 'visible' : 'hidden', "."));
180
- log("No default rule found.");
181
- if (requiredFnExists) return logAndReturn(true, "Only the requiredVisibility rule was found. This returned true. => This feature will be visible.");
182
- return logAndReturn(false, 'No rules were found. This feature will be hidden.');
183
- }
184
- var api = {
185
- name: 'feature-toggle-api',
186
- setData: function setData(nameParam, variantOrDataParam, dataParam) {
187
- if (nameParam == undefined) throw new Error('setData(): The name must of the feature must be defined, but ist undefined');
188
- var variant = dataParam != undefined ? variantOrDataParam : undefined;
189
- var data = dataParam || variantOrDataParam;
190
- var event = getEvent(nameParam, variant, data);
191
- globals.datas[event.key] = event.data;
192
- triggerEvent('visibilityrule', event);
193
- },
194
- on: function on(eventtype, fn, config) {
195
- globals.listeners[eventtype] = globals.listeners[eventtype] || [];
196
- globals.listeners[eventtype].push(fn);
197
- triggerEvent('registerEvent', {
198
- type: eventtype
199
- });
200
- if (config != undefined && config.ignorePreviousRules) return;
201
- Object.keys(globals.visibilities).forEach(function (key) {
202
- var event = parseKey(key);
203
- var rule = globals.visibilities[key];
204
- event.result = rule(event);
205
- fn(event);
206
- });
207
- },
208
- trigger: triggerEvent,
209
- showLogs: function showLogs(_showLogs) {
210
- globals.showLogs = _showLogs == undefined ? true : _showLogs;
211
- },
212
- isVisible: isVisible,
213
- /*
214
- the following function calls are possible:
215
- visibility(name,result);
216
- visibility(name,variant,result);
217
- visibility(name,variant,data,result);
218
- */
219
- visibility: function visibility(param1, param2, param3, param4) {
220
- var params = visibilityFnParams(param1, param2, param3, param4);
221
- var event = getEvent(params.name, params.variant, params.data, params.result);
222
- globals.visibilities[event.key] = event.visibilityFunction;
223
- globals.datas[event.key] = event.data;
224
- triggerEvent('visibilityrule', event);
225
- },
226
- requiredVisibility: function requiredVisibility(fn) {
227
- if (typeof fn != "function") throw new Error('feature.requiredVisibility(): 1st parameter must be a function, but is ' + _typeof(fn));
228
- globals.visibilities['_required'] = parseToFn(fn);
229
- },
230
- defaultVisibility: function defaultVisibility(fn) {
231
- if (typeof fn != "function") throw new Error('feature.defaultVisibility(): 1st parameter must be a function, but is ' + _typeof(fn));
232
- globals.visibilities['_default'] = parseToFn(fn);
233
- },
234
- addPlugin: function addPlugin(plugin) {
235
- if (globals.usedPlugins.includes(plugin)) return;
236
- _addPlugin(plugin, api);
237
- globals.usedPlugins.push(plugin);
238
- }
239
- };
240
- init(api);
241
- return api;
242
- }
243
- window.featureToggleApi = featuretoggleapi;
@@ -1 +0,0 @@
1
- "use strict";function _typeof(obj){"@babel/helpers - typeof";return _typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(obj){return typeof obj}:function(obj){return obj&&"function"==typeof Symbol&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj},_typeof(obj)}var parseToFn=function parseToFn(fnOrBool){if(typeof fnOrBool=="boolean")return function(){return fnOrBool};return fnOrBool};var getKey=function getKey(name,variant){var _name=name.toLowerCase();if(typeof variant=="string"){_name+="#"+variant.toLowerCase()}return _name};function initVisibilities(){var visibilities=arguments.length>0&&arguments[0]!==undefined?arguments[0]:{};var returnVisibilities={};Object.keys(visibilities).forEach(function(key){if(key.startsWith("_"))return;returnVisibilities[getKey(key)]=parseToFn(visibilities[key])});return returnVisibilities}function featuretoggleapi(){var config=arguments.length>0&&arguments[0]!==undefined?arguments[0]:{};var globals={datas:{},listeners:{},visibilities:initVisibilities(config),showLogs:false,usedPlugins:[]};function init(api){if(config._plugins){if(!Array.isArray(config._plugins))throw new Error("featuretoggleapi()-constructor: config.plugins must be an array.");config._plugins.forEach(function(plugin){if(typeof plugin!=="function")throw new Error("featuretoggleapi()-constructor: config.plugins needs functions as entries, not "+_typeof(plugin)+".");_addPlugin(plugin,api)})}triggerEvent("init")}function _addPlugin(plugin,api){plugin(api)}function triggerEvent(eventtype,param){(globals.listeners[eventtype]||[]).forEach(function(listener){listener(param)})}var log=function log(message){if(!globals.showLogs)return;if(typeof window==="undefined"){var loggedMessage=message.replace(/<b>/g,"");console.log(loggedMessage);return}var hasBoldTag=message.indexOf("<b>")!=-1;var hasVisibleKeyword=message.indexOf("visible")!=-1;var hasHiddenKeyword=message.indexOf("hidden")!=-1;var _message=message.replace("visible","%cvisible");_message=_message.replace("hidden","%chidden");if(hasVisibleKeyword)console.log(_message,"color:green;font-weight:bold;");else if(hasHiddenKeyword)console.log(_message,"color:red;font-weight:bold;");else if(hasBoldTag){_message=_message.replace("<b>","%c");var parts=[_message,"font-weight:bold;"];console.log.apply(null,parts)}else console.log(message)};var logAndReturn=function logAndReturn(returnValue,message){log(message);log("");return returnValue};var getVisibility=function getVisibility(visibilityFn,functionname,name,variant,data){if(visibilityFn==null)return undefined;var calculatedVisibility=visibilityFn({name:name,variant:variant,data:data});if(typeof calculatedVisibility=="boolean"){return calculatedVisibility}return logAndReturn(false,"The ".concat(functionname," returns ").concat(calculatedVisibility,". => Please return true or false. This result (and all non-boolean results) will return false."))};function parseKey(key){var parts=key.split("#");return{name:parts[0],variant:parts.length>1?parts[1]:undefined,data:globals.datas[key]}}function visibilityFnParams(param1,param2,param3,param4){if(param1==undefined)throw new Error("feature.visibility(): 1st parameter name must be defined");if(arguments.length==1)throw new Error("feature.visibility(): 2nd parameter name must be a boolean or function, but is empty");var name=param1,variant=null,data=null,result=null;if(param3==undefined&&param4==undefined){result=param2}else if(param4==undefined){variant=param2;result=param3}else{variant=param2;data=param3;result=param4}return{name:name,variant:variant,data:data,result:result}}function getEvent(name,variant,data,result){var event;event={name:name,variant:variant,data:data};event.key=getKey(event.name,event.variant);if(result==null)return event;event.visibilityFunction=parseToFn(result);event.result=event.visibilityFunction({name:event.name,variant:event.variant,data:event.data||{},_internalCall:true,description:"When attaching a function, the result must be calculated internally. You can filter this out with the _internalCall:true -Flag."});return event}function isVisible(name,variant,data){var visibilities=globals.visibilities;log('\nCheck Visibility of <b>Feature "'.concat(name,'", variant "').concat(variant==undefined?"":variant,'"').concat(data?" with data "+JSON.stringify(data):"","."));if(name==undefined)throw new Error('The attribute "name" is required for tag <feature></feature>. Example: <feature name="aname"></feature>');var requiredFn=visibilities["_required"];var requiredFnExists=visibilities["_required"]!=null;var requiredFnResult=getVisibility(requiredFn,"requiredVisibility",name,variant,data);var visibilityFnKey=getKey(name,variant);var visibilityFn=visibilities[visibilityFnKey];var visibilityFnExists=visibilities[visibilityFnKey]!=null;var visibilityFnResult=getVisibility(visibilityFn,"visibility function",name,variant,data);var variantExists=variant!=null;var visibilityOnlyNameFnKey=getKey(name,null);var visibilityOnlyNameFn=visibilities[visibilityOnlyNameFnKey];visibilities[visibilityOnlyNameFnKey]!=null;var visibilityOnlyNameFnResult=getVisibility(visibilityOnlyNameFn,"visibility function (only name)",name,variant,data);var defaultFn=visibilities["_default"];var defaultFnExists=visibilities["_default"]!=null;var defaultFnResult=getVisibility(defaultFn,"defaultVisibility",name,variant,data);if(!requiredFnExists)log("No requiredVisibility rule specified for this feature.");else if(requiredFnExists&&requiredFnResult===true)log("The requiredVisibility rule returns true. This feature will be shown when no other rule rejects it.");else if(requiredFnExists&&requiredFnResult===false)return logAndReturn(false,"The requiredVisibility rule returns false. This feature will be hidden.");if(visibilityFnExists)return logAndReturn(visibilityFnResult,"The visibility rule returns ".concat(visibilityFnResult,". This feature will be ").concat(visibilityFnResult?"visible":"hidden","."));log("No visibility rule found matching name and variant.");if(variantExists&&typeof visibilityOnlyNameFnResult=="boolean")return logAndReturn(visibilityOnlyNameFnResult,"Found a visibility rule for name ".concat(name," without variants. The rule returns ").concat(visibilityOnlyNameFnResult,". => This feature will be ").concat(visibilityOnlyNameFnResult?"visible":"hidden","."));else if(variantExists)log("No rules found for name ".concat(name," without variants."));if(defaultFnExists)return logAndReturn(defaultFnResult,"Found a defaultVisibility rule. The rule returns ".concat(defaultFnResult,". => This feature will be ").concat(defaultFnResult?"visible":"hidden","."));log("No default rule found.");if(requiredFnExists)return logAndReturn(true,"Only the requiredVisibility rule was found. This returned true. => This feature will be visible.");return logAndReturn(false,"No rules were found. This feature will be hidden.")}var api={name:"feature-toggle-api",setData:function setData(nameParam,variantOrDataParam,dataParam){if(nameParam==undefined)throw new Error("setData(): The name must of the feature must be defined, but ist undefined");var variant=dataParam!=undefined?variantOrDataParam:undefined;var data=dataParam||variantOrDataParam;var event=getEvent(nameParam,variant,data);globals.datas[event.key]=event.data;triggerEvent("visibilityrule",event)},on:function on(eventtype,fn,config){globals.listeners[eventtype]=globals.listeners[eventtype]||[];globals.listeners[eventtype].push(fn);triggerEvent("registerEvent",{type:eventtype});if(config!=undefined&&config.ignorePreviousRules)return;Object.keys(globals.visibilities).forEach(function(key){var event=parseKey(key);var rule=globals.visibilities[key];event.result=rule(event);fn(event)})},trigger:triggerEvent,showLogs:function showLogs(_showLogs){globals.showLogs=_showLogs==undefined?true:_showLogs},isVisible:isVisible,visibility:function visibility(param1,param2,param3,param4){var params=visibilityFnParams(param1,param2,param3,param4);var event=getEvent(params.name,params.variant,params.data,params.result);globals.visibilities[event.key]=event.visibilityFunction;globals.datas[event.key]=event.data;triggerEvent("visibilityrule",event)},requiredVisibility:function requiredVisibility(fn){if(typeof fn!="function")throw new Error("feature.requiredVisibility(): 1st parameter must be a function, but is "+_typeof(fn));globals.visibilities["_required"]=parseToFn(fn)},defaultVisibility:function defaultVisibility(fn){if(typeof fn!="function")throw new Error("feature.defaultVisibility(): 1st parameter must be a function, but is "+_typeof(fn));globals.visibilities["_default"]=parseToFn(fn)},addPlugin:function addPlugin(plugin){if(globals.usedPlugins.includes(plugin))return;_addPlugin(plugin,api);globals.usedPlugins.push(plugin)}};init(api);return api}window.featureToggleApi=featuretoggleapi;
@@ -1,243 +0,0 @@
1
- 'use strict';
2
-
3
- function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
4
- var parseToFn = function parseToFn(fnOrBool) {
5
- if (typeof fnOrBool == 'boolean') return function () {
6
- return fnOrBool;
7
- };
8
- return fnOrBool;
9
- };
10
- var getKey = function getKey(name, variant) {
11
- var _name = name.toLowerCase();
12
- if (typeof variant == 'string') {
13
- _name += "#" + variant.toLowerCase();
14
- }
15
- return _name;
16
- };
17
- function initVisibilities() {
18
- var visibilities = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
19
- var returnVisibilities = {};
20
- Object.keys(visibilities).forEach(function (key) {
21
- if (key.startsWith('_')) return;
22
- returnVisibilities[getKey(key)] = parseToFn(visibilities[key]);
23
- });
24
- return returnVisibilities;
25
- }
26
- function featuretoggleapi() {
27
- var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
28
- var globals = {
29
- datas: {},
30
- listeners: {},
31
- visibilities: initVisibilities(config),
32
- showLogs: false,
33
- usedPlugins: []
34
- };
35
- function init(api) {
36
- if (config._plugins) {
37
- if (!Array.isArray(config._plugins)) throw new Error('featuretoggleapi()-constructor: config.plugins must be an array.');
38
- config._plugins.forEach(function (plugin) {
39
- if (typeof plugin !== 'function') throw new Error('featuretoggleapi()-constructor: config.plugins needs functions as entries, not ' + _typeof(plugin) + '.');
40
- _addPlugin(plugin, api);
41
- });
42
- }
43
- triggerEvent('init');
44
- }
45
- function _addPlugin(plugin, api) {
46
- plugin(api);
47
- }
48
- function triggerEvent(eventtype, param) {
49
- (globals.listeners[eventtype] || []).forEach(function (listener) {
50
- listener(param);
51
- });
52
- }
53
- var log = function log(message) {
54
- if (!globals.showLogs) return;
55
-
56
- //Nur Browser können Syntaxhighlighting die anderen geben die Nachricht einfach aus und schneiden
57
- //die styletags raus
58
- if (typeof window === 'undefined') {
59
- var loggedMessage = message.replace(/<b>/g, "");
60
- console.log(loggedMessage);
61
- return;
62
- }
63
- var hasBoldTag = message.indexOf('<b>') != -1;
64
- var hasVisibleKeyword = message.indexOf('visible') != -1;
65
- var hasHiddenKeyword = message.indexOf('hidden') != -1;
66
- var _message = message.replace('visible', '%cvisible');
67
- _message = _message.replace('hidden', '%chidden');
68
- if (hasVisibleKeyword) console.log(_message, "color:green;font-weight:bold;");else if (hasHiddenKeyword) console.log(_message, "color:red;font-weight:bold;");else if (hasBoldTag) {
69
- _message = _message.replace('<b>', '%c');
70
- var parts = [_message, 'font-weight:bold;'];
71
- console.log.apply(null, parts);
72
- } else console.log(message);
73
- };
74
- var logAndReturn = function logAndReturn(returnValue, message) {
75
- log(message);
76
- log('');
77
- return returnValue;
78
- };
79
- var getVisibility = function getVisibility(visibilityFn, functionname, name, variant, data) {
80
- if (visibilityFn == null) return undefined;
81
- var calculatedVisibility = visibilityFn({
82
- name: name,
83
- variant: variant,
84
- data: data
85
- });
86
- if (typeof calculatedVisibility == 'boolean') {
87
- return calculatedVisibility;
88
- }
89
- return logAndReturn(false, "The ".concat(functionname, " returns ").concat(calculatedVisibility, ". => Please return true or false. This result (and all non-boolean results) will return false."));
90
- };
91
- function parseKey(key) {
92
- var parts = key.split('#');
93
- return {
94
- name: parts[0],
95
- variant: parts.length > 1 ? parts[1] : undefined,
96
- data: globals.datas[key]
97
- };
98
- }
99
-
100
- /*
101
- the following calls are possible:
102
- visibility(name,result);
103
- visibility(name,variant,result);
104
- visibility(name,variant,data,result);
105
-
106
- =>
107
- param1: name
108
- param2: result || variant
109
- param3: result || data
110
- param4: result
111
- */
112
- function visibilityFnParams(param1, param2, param3, param4) {
113
- //name must always be set
114
- if (param1 == undefined) throw new Error('feature.visibility(): 1st parameter name must be defined');
115
- if (arguments.length == 1) throw new Error('feature.visibility(): 2nd parameter name must be a boolean or function, but is empty');
116
- var name = param1,
117
- variant = null,
118
- data = null,
119
- result = null;
120
- if (param3 == undefined && param4 == undefined) {
121
- result = param2;
122
- } else if (param4 == undefined) {
123
- variant = param2;
124
- result = param3;
125
- } else {
126
- variant = param2;
127
- data = param3;
128
- result = param4;
129
- }
130
- return {
131
- name: name,
132
- variant: variant,
133
- data: data,
134
- result: result
135
- };
136
- }
137
- function getEvent(name, variant, data, result) {
138
- var event;
139
- event = {
140
- name: name,
141
- variant: variant,
142
- data: data
143
- };
144
- event.key = getKey(event.name, event.variant);
145
- if (result == null) return event;
146
- event.visibilityFunction = parseToFn(result);
147
- event.result = event.visibilityFunction({
148
- name: event.name,
149
- variant: event.variant,
150
- data: event.data || {},
151
- _internalCall: true,
152
- description: 'When attaching a function, the result must be calculated internally. You can filter this out with the _internalCall:true -Flag.'
153
- });
154
- return event;
155
- }
156
- function isVisible(name, variant, data) {
157
- var visibilities = globals.visibilities;
158
- log("\nCheck Visibility of <b>Feature \"".concat(name, "\", variant \"").concat(variant == undefined ? '' : variant, "\"").concat(data ? " with data " + JSON.stringify(data) : "", "."));
159
- if (name == undefined) throw new Error('The attribute "name" is required for tag <feature></feature>. Example: <feature name="aname"></feature>');
160
- var requiredFn = visibilities['_required'];
161
- var requiredFnExists = visibilities['_required'] != null;
162
- var requiredFnResult = getVisibility(requiredFn, 'requiredVisibility', name, variant, data);
163
- var visibilityFnKey = getKey(name, variant);
164
- var visibilityFn = visibilities[visibilityFnKey];
165
- var visibilityFnExists = visibilities[visibilityFnKey] != null;
166
- var visibilityFnResult = getVisibility(visibilityFn, 'visibility function', name, variant, data);
167
- var variantExists = variant != null;
168
- var visibilityOnlyNameFnKey = getKey(name, null);
169
- var visibilityOnlyNameFn = visibilities[visibilityOnlyNameFnKey];
170
- visibilities[visibilityOnlyNameFnKey] != null;
171
- var visibilityOnlyNameFnResult = getVisibility(visibilityOnlyNameFn, 'visibility function (only name)', name, variant, data);
172
- var defaultFn = visibilities['_default'];
173
- var defaultFnExists = visibilities['_default'] != null;
174
- var defaultFnResult = getVisibility(defaultFn, 'defaultVisibility', name, variant, data);
175
- if (!requiredFnExists) log("No requiredVisibility rule specified for this feature.");else if (requiredFnExists && requiredFnResult === true) log("The requiredVisibility rule returns true. This feature will be shown when no other rule rejects it.");else if (requiredFnExists && requiredFnResult === false) return logAndReturn(false, "The requiredVisibility rule returns false. This feature will be hidden.");
176
- if (visibilityFnExists) return logAndReturn(visibilityFnResult, "The visibility rule returns ".concat(visibilityFnResult, ". This feature will be ").concat(visibilityFnResult ? 'visible' : 'hidden', "."));
177
- log('No visibility rule found matching name and variant.');
178
- if (variantExists && typeof visibilityOnlyNameFnResult == 'boolean') return logAndReturn(visibilityOnlyNameFnResult, "Found a visibility rule for name ".concat(name, " without variants. The rule returns ").concat(visibilityOnlyNameFnResult, ". => This feature will be ").concat(visibilityOnlyNameFnResult ? 'visible' : 'hidden', "."));else if (variantExists) log("No rules found for name ".concat(name, " without variants."));
179
- if (defaultFnExists) return logAndReturn(defaultFnResult, "Found a defaultVisibility rule. The rule returns ".concat(defaultFnResult, ". => This feature will be ").concat(defaultFnResult ? 'visible' : 'hidden', "."));
180
- log("No default rule found.");
181
- if (requiredFnExists) return logAndReturn(true, "Only the requiredVisibility rule was found. This returned true. => This feature will be visible.");
182
- return logAndReturn(false, 'No rules were found. This feature will be hidden.');
183
- }
184
- var api = {
185
- name: 'feature-toggle-api',
186
- setData: function setData(nameParam, variantOrDataParam, dataParam) {
187
- if (nameParam == undefined) throw new Error('setData(): The name must of the feature must be defined, but ist undefined');
188
- var variant = dataParam != undefined ? variantOrDataParam : undefined;
189
- var data = dataParam || variantOrDataParam;
190
- var event = getEvent(nameParam, variant, data);
191
- globals.datas[event.key] = event.data;
192
- triggerEvent('visibilityrule', event);
193
- },
194
- on: function on(eventtype, fn, config) {
195
- globals.listeners[eventtype] = globals.listeners[eventtype] || [];
196
- globals.listeners[eventtype].push(fn);
197
- triggerEvent('registerEvent', {
198
- type: eventtype
199
- });
200
- if (config != undefined && config.ignorePreviousRules) return;
201
- Object.keys(globals.visibilities).forEach(function (key) {
202
- var event = parseKey(key);
203
- var rule = globals.visibilities[key];
204
- event.result = rule(event);
205
- fn(event);
206
- });
207
- },
208
- trigger: triggerEvent,
209
- showLogs: function showLogs(_showLogs) {
210
- globals.showLogs = _showLogs == undefined ? true : _showLogs;
211
- },
212
- isVisible: isVisible,
213
- /*
214
- the following function calls are possible:
215
- visibility(name,result);
216
- visibility(name,variant,result);
217
- visibility(name,variant,data,result);
218
- */
219
- visibility: function visibility(param1, param2, param3, param4) {
220
- var params = visibilityFnParams(param1, param2, param3, param4);
221
- var event = getEvent(params.name, params.variant, params.data, params.result);
222
- globals.visibilities[event.key] = event.visibilityFunction;
223
- globals.datas[event.key] = event.data;
224
- triggerEvent('visibilityrule', event);
225
- },
226
- requiredVisibility: function requiredVisibility(fn) {
227
- if (typeof fn != "function") throw new Error('feature.requiredVisibility(): 1st parameter must be a function, but is ' + _typeof(fn));
228
- globals.visibilities['_required'] = parseToFn(fn);
229
- },
230
- defaultVisibility: function defaultVisibility(fn) {
231
- if (typeof fn != "function") throw new Error('feature.defaultVisibility(): 1st parameter must be a function, but is ' + _typeof(fn));
232
- globals.visibilities['_default'] = parseToFn(fn);
233
- },
234
- addPlugin: function addPlugin(plugin) {
235
- if (globals.usedPlugins.includes(plugin)) return;
236
- _addPlugin(plugin, api);
237
- globals.usedPlugins.push(plugin);
238
- }
239
- };
240
- init(api);
241
- return api;
242
- }
243
- module.exports = featuretoggleapi;