@tolgee/core 2.4.0 → 2.8.1

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.
package/README.md CHANGED
@@ -1,10 +1,11 @@
1
+ # Tolgee core library
1
2
  ![test workflow](https://github.com/tolgee/tolgee-js/actions/workflows/test.yml/badge.svg)
2
3
  ![@tolgee/core version](https://img.shields.io/npm/v/@tolgee/core?label=%40tolgee%2Fcore)
3
4
  ![types typescript](https://img.shields.io/badge/Types-Typescript-blue)
4
5
  [![twitter](https://img.shields.io/twitter/follow/Tolgee_i18n?style=social)](https://twitter.com/Tolgee_i18n)
5
6
  [![github stars](https://img.shields.io/github/stars/tolgee/tolgee-js?style=social)](https://github.com/tolgee/tolgee-js)
6
7
 
7
- # Tolgee core library
8
+
8
9
 
9
10
  [<img src="https://raw.githubusercontent.com/tolgee/documentation/main/tolgee_logo_text.svg" alt="Tolgee" width="200" />](https://tolgee.io)
10
11
 
@@ -129,23 +129,6 @@ var TOLGEE_WRAPPED_ONLY_DATA_ATTRIBUTE = 'data-tolgee-key-only';
129
129
  var NodeHelper = /** @class */ (function () {
130
130
  function NodeHelper() {
131
131
  }
132
- NodeHelper.evaluateGenerator = function (expression, targetNode) {
133
- var node, evaluated;
134
- return __generator(this, function (_a) {
135
- switch (_a.label) {
136
- case 0:
137
- evaluated = document.evaluate(expression, targetNode, undefined, XPathResult.ANY_TYPE);
138
- _a.label = 1;
139
- case 1:
140
- if (!((node = evaluated.iterateNext()) !== null)) return [3 /*break*/, 3];
141
- return [4 /*yield*/, node];
142
- case 2:
143
- _a.sent();
144
- return [3 /*break*/, 1];
145
- case 3: return [2 /*return*/];
146
- }
147
- });
148
- };
149
132
  NodeHelper.evaluate = function () {
150
133
  var args = [];
151
134
  for (var _i = 0; _i < arguments.length; _i++) {
@@ -195,13 +178,31 @@ var NodeHelper = /** @class */ (function () {
195
178
  return true;
196
179
  }
197
180
  if (node instanceof Attr) {
198
- var ownerContainsAttr = Object.values(node.ownerElement.attributes).indexOf(node) > -1;
181
+ var ownerContainsAttr = node.ownerElement &&
182
+ Object.values(node.ownerElement.attributes).indexOf(node) > -1;
199
183
  if (descendant.contains(node.ownerElement) && ownerContainsAttr) {
200
184
  return true;
201
185
  }
202
186
  }
203
187
  return false;
204
188
  };
189
+ NodeHelper.evaluateGenerator = function (expression, targetNode) {
190
+ var node, evaluated;
191
+ return __generator(this, function (_a) {
192
+ switch (_a.label) {
193
+ case 0:
194
+ evaluated = document.evaluate(expression, targetNode, undefined, XPathResult.ANY_TYPE);
195
+ _a.label = 1;
196
+ case 1:
197
+ if (!((node = evaluated.iterateNext()) !== null)) return [3 /*break*/, 3];
198
+ return [4 /*yield*/, node];
199
+ case 2:
200
+ _a.sent();
201
+ return [3 /*break*/, 1];
202
+ case 3: return [2 /*return*/];
203
+ }
204
+ });
205
+ };
205
206
  return NodeHelper;
206
207
  }());
207
208
 
@@ -1595,8 +1596,8 @@ function parseNumberSkeleton(tokens) {
1595
1596
  }
1596
1597
 
1597
1598
  var _a;
1598
- var SPACE_SEPARATOR_START_REGEX = new RegExp("^" + SPACE_SEPARATOR_REGEX.source + "*");
1599
- var SPACE_SEPARATOR_END_REGEX = new RegExp(SPACE_SEPARATOR_REGEX.source + "*$");
1599
+ var SPACE_SEPARATOR_START_REGEX = new RegExp("^".concat(SPACE_SEPARATOR_REGEX.source, "*"));
1600
+ var SPACE_SEPARATOR_END_REGEX = new RegExp("".concat(SPACE_SEPARATOR_REGEX.source, "*$"));
1600
1601
  function createLocation(start, end) {
1601
1602
  return { start: start, end: end };
1602
1603
  }
@@ -1843,7 +1844,7 @@ var Parser = /** @class */ (function () {
1843
1844
  return {
1844
1845
  val: {
1845
1846
  type: TYPE.literal,
1846
- value: "<" + tagName + "/>",
1847
+ value: "<".concat(tagName, "/>"),
1847
1848
  location: createLocation(startPosition, this.clonePosition()),
1848
1849
  },
1849
1850
  err: null,
@@ -2448,7 +2449,7 @@ var Parser = /** @class */ (function () {
2448
2449
  }
2449
2450
  var code = codePointAt(this.message, offset);
2450
2451
  if (code === undefined) {
2451
- throw Error("Offset " + offset + " is at invalid UTF-16 code unit boundary");
2452
+ throw Error("Offset ".concat(offset, " is at invalid UTF-16 code unit boundary"));
2452
2453
  }
2453
2454
  return code;
2454
2455
  };
@@ -2516,7 +2517,7 @@ var Parser = /** @class */ (function () {
2516
2517
  */
2517
2518
  Parser.prototype.bumpTo = function (targetOffset) {
2518
2519
  if (this.offset() > targetOffset) {
2519
- throw Error("targetOffset " + targetOffset + " must be greater than or equal to the current offset " + this.offset());
2520
+ throw Error("targetOffset ".concat(targetOffset, " must be greater than or equal to the current offset ").concat(this.offset()));
2520
2521
  }
2521
2522
  targetOffset = Math.min(targetOffset, this.message.length);
2522
2523
  while (true) {
@@ -2525,7 +2526,7 @@ var Parser = /** @class */ (function () {
2525
2526
  break;
2526
2527
  }
2527
2528
  if (offset > targetOffset) {
2528
- throw Error("targetOffset " + targetOffset + " is at invalid UTF-16 code unit boundary");
2529
+ throw Error("targetOffset ".concat(targetOffset, " is at invalid UTF-16 code unit boundary"));
2529
2530
  }
2530
2531
  this.bump();
2531
2532
  if (this.isEOF()) {
@@ -2991,28 +2992,28 @@ var FormatError = /** @class */ (function (_super) {
2991
2992
  return _this;
2992
2993
  }
2993
2994
  FormatError.prototype.toString = function () {
2994
- return "[formatjs Error: " + this.code + "] " + this.message;
2995
+ return "[formatjs Error: ".concat(this.code, "] ").concat(this.message);
2995
2996
  };
2996
2997
  return FormatError;
2997
2998
  }(Error));
2998
2999
  var InvalidValueError = /** @class */ (function (_super) {
2999
3000
  __extends(InvalidValueError, _super);
3000
3001
  function InvalidValueError(variableId, value, options, originalMessage) {
3001
- return _super.call(this, "Invalid values for \"" + variableId + "\": \"" + value + "\". Options are \"" + Object.keys(options).join('", "') + "\"", ErrorCode.INVALID_VALUE, originalMessage) || this;
3002
+ return _super.call(this, "Invalid values for \"".concat(variableId, "\": \"").concat(value, "\". Options are \"").concat(Object.keys(options).join('", "'), "\""), ErrorCode.INVALID_VALUE, originalMessage) || this;
3002
3003
  }
3003
3004
  return InvalidValueError;
3004
3005
  }(FormatError));
3005
3006
  var InvalidValueTypeError = /** @class */ (function (_super) {
3006
3007
  __extends(InvalidValueTypeError, _super);
3007
3008
  function InvalidValueTypeError(value, type, originalMessage) {
3008
- return _super.call(this, "Value for \"" + value + "\" must be of type " + type, ErrorCode.INVALID_VALUE, originalMessage) || this;
3009
+ return _super.call(this, "Value for \"".concat(value, "\" must be of type ").concat(type), ErrorCode.INVALID_VALUE, originalMessage) || this;
3009
3010
  }
3010
3011
  return InvalidValueTypeError;
3011
3012
  }(FormatError));
3012
3013
  var MissingValueError = /** @class */ (function (_super) {
3013
3014
  __extends(MissingValueError, _super);
3014
3015
  function MissingValueError(variableId, originalMessage) {
3015
- return _super.call(this, "The intl string context variable \"" + variableId + "\" was not provided to the string \"" + originalMessage + "\"", ErrorCode.MISSING_VALUE, originalMessage) || this;
3016
+ return _super.call(this, "The intl string context variable \"".concat(variableId, "\" was not provided to the string \"").concat(originalMessage, "\""), ErrorCode.MISSING_VALUE, originalMessage) || this;
3016
3017
  }
3017
3018
  return MissingValueError;
3018
3019
  }(FormatError));
@@ -3173,7 +3174,7 @@ originalMessage) {
3173
3174
  continue;
3174
3175
  }
3175
3176
  if (isPluralElement(el)) {
3176
- var opt = el.options["=" + value];
3177
+ var opt = el.options["=".concat(value)];
3177
3178
  if (!opt) {
3178
3179
  if (!Intl.PluralRules) {
3179
3180
  throw new FormatError("Intl.PluralRules is not available in this environment.\nTry polyfilling it using \"@formatjs/intl-pluralrules\"\n", ErrorCode.MISSING_INTL_API, originalMessage);
@@ -3684,7 +3685,7 @@ var MouseEventHandler = /** @class */ (function () {
3684
3685
  }
3685
3686
  };
3686
3687
  element.addEventListener('mouseover', onMouseOver);
3687
- element.addEventListener('click', onClick);
3688
+ element.addEventListener('click', onClick, { capture: true });
3688
3689
  var onMouseDownOrUp = function (e) {
3689
3690
  if (_this.areKeysDown()) {
3690
3691
  e.stopPropagation();
@@ -3698,7 +3699,7 @@ var MouseEventHandler = /** @class */ (function () {
3698
3699
  element.removeEventListener('mousedown', onMouseDownOrUp);
3699
3700
  element.removeEventListener('mouseup', onMouseDownOrUp);
3700
3701
  element.removeEventListener('mouseover', onMouseOver);
3701
- element.removeEventListener('click', onClick);
3702
+ element.removeEventListener('click', onClick, { capture: true });
3702
3703
  element.removeEventListener('mouseout', onMouseOut);
3703
3704
  };
3704
3705
  };
@@ -3719,11 +3720,13 @@ var MouseEventHandler = /** @class */ (function () {
3719
3720
  }
3720
3721
  };
3721
3722
  MouseEventHandler.prototype.onMouseOut = function (element) {
3723
+ element._tolgee.preventClean = false;
3722
3724
  this.mouseOn.delete(element);
3723
3725
  this.mouseOnChanged.emit(this.getMouseOn());
3724
3726
  };
3725
3727
  MouseEventHandler.prototype.onMouseOver = function (element) {
3726
3728
  this.filterMouseOn();
3729
+ element._tolgee.preventClean = true;
3727
3730
  this.mouseOn.delete(element); //to get in to last place
3728
3731
  this.mouseOn.add(element);
3729
3732
  this.mouseOnChanged.emit(this.getMouseOn());
@@ -3785,40 +3788,26 @@ var TranslationHighlighter = /** @class */ (function () {
3785
3788
  var _this = this;
3786
3789
  this.dependencies = dependencies;
3787
3790
  this.translationEdit = function (e, element) { return __awaiter(_this, void 0, void 0, function () {
3788
- var key;
3791
+ var renderer, key;
3789
3792
  return __generator(this, function (_a) {
3790
3793
  switch (_a.label) {
3791
- case 0:
3792
- if (!(typeof this.renderer === 'object')) return [3 /*break*/, 2];
3793
- return [4 /*yield*/, this.getKeyAndDefault(e, element)];
3794
+ case 0: return [4 /*yield*/, this.getRenderer()];
3794
3795
  case 1:
3796
+ renderer = _a.sent();
3797
+ if (!(typeof renderer === 'object')) return [3 /*break*/, 3];
3798
+ return [4 /*yield*/, this.getKeyAndDefault(e, element)];
3799
+ case 2:
3795
3800
  key = _a.sent();
3796
3801
  if (key) {
3797
- this.renderer.renderViewer(key.key, key.defaultValue);
3802
+ renderer.renderViewer(key.key, key.defaultValue);
3798
3803
  return [2 /*return*/];
3799
3804
  }
3800
3805
  return [2 /*return*/];
3801
- case 2:
3802
- // eslint-disable-next-line no-console
3803
- console.warn('Tolgee UI is not provided. To translate interactively provide tolgee ui constructor to "ui" configuration property. ' +
3804
- 'To disable highlighting use production mode.');
3805
- return [2 /*return*/];
3806
+ case 3: return [2 /*return*/];
3806
3807
  }
3807
3808
  });
3808
3809
  }); };
3809
3810
  }
3810
- Object.defineProperty(TranslationHighlighter.prototype, "renderer", {
3811
- get: function () {
3812
- if (this._renderer === undefined) {
3813
- if (typeof this.dependencies.properties.config.ui === 'function') {
3814
- this._renderer = new this.dependencies.properties.config.ui(this.dependencies);
3815
- }
3816
- }
3817
- return this._renderer;
3818
- },
3819
- enumerable: false,
3820
- configurable: true
3821
- });
3822
3811
  TranslationHighlighter.getKeyOptions = function (node) {
3823
3812
  var nodes = Array.from(node._tolgee.nodes);
3824
3813
  return nodes.reduce(function (acc, curr) { return __spreadArray(__spreadArray([], __read(acc), false), __read(curr._tolgee.keys.map(function (k) { return ({
@@ -3836,9 +3825,70 @@ var TranslationHighlighter = /** @class */ (function () {
3836
3825
  }
3837
3826
  }); }); });
3838
3827
  };
3828
+ TranslationHighlighter.prototype.getRenderer = function () {
3829
+ return __awaiter(this, void 0, void 0, function () {
3830
+ var possibleProviders, possibleProviders_1, possibleProviders_1_1, possibleProvider, constructorProvider, constructor, constructor, e_2_1;
3831
+ var e_2, _a;
3832
+ return __generator(this, function (_b) {
3833
+ switch (_b.label) {
3834
+ case 0:
3835
+ if (!(this._renderer === undefined)) return [3 /*break*/, 11];
3836
+ possibleProviders = [
3837
+ this.dependencies.properties.config.ui,
3838
+ window['@tolgee/ui'],
3839
+ ];
3840
+ _b.label = 1;
3841
+ case 1:
3842
+ _b.trys.push([1, 8, 9, 10]);
3843
+ possibleProviders_1 = __values(possibleProviders), possibleProviders_1_1 = possibleProviders_1.next();
3844
+ _b.label = 2;
3845
+ case 2:
3846
+ if (!!possibleProviders_1_1.done) return [3 /*break*/, 7];
3847
+ possibleProvider = possibleProviders_1_1.value;
3848
+ if (!(typeof possibleProvider === 'function')) return [3 /*break*/, 6];
3849
+ _b.label = 3;
3850
+ case 3:
3851
+ _b.trys.push([3, 5, , 6]);
3852
+ constructorProvider = possibleProvider;
3853
+ return [4 /*yield*/, constructorProvider()];
3854
+ case 4:
3855
+ constructor = _b.sent();
3856
+ this._renderer = new constructor(this.dependencies);
3857
+ return [3 /*break*/, 6];
3858
+ case 5:
3859
+ _b.sent();
3860
+ constructor = possibleProvider;
3861
+ this._renderer = new constructor(this.dependencies);
3862
+ return [3 /*break*/, 6];
3863
+ case 6:
3864
+ possibleProviders_1_1 = possibleProviders_1.next();
3865
+ return [3 /*break*/, 2];
3866
+ case 7: return [3 /*break*/, 10];
3867
+ case 8:
3868
+ e_2_1 = _b.sent();
3869
+ e_2 = { error: e_2_1 };
3870
+ return [3 /*break*/, 10];
3871
+ case 9:
3872
+ try {
3873
+ if (possibleProviders_1_1 && !possibleProviders_1_1.done && (_a = possibleProviders_1.return)) _a.call(possibleProviders_1);
3874
+ }
3875
+ finally { if (e_2) throw e_2.error; }
3876
+ return [7 /*endfinally*/];
3877
+ case 10:
3878
+ if (this._renderer === undefined) {
3879
+ // eslint-disable-next-line no-console
3880
+ console.warn('Tolgee UI is not provided. To translate interactively provide tolgee ui constructor to "ui" configuration property. ' +
3881
+ 'To disable highlighting use production mode.');
3882
+ }
3883
+ _b.label = 11;
3884
+ case 11: return [2 /*return*/, this._renderer];
3885
+ }
3886
+ });
3887
+ });
3888
+ };
3839
3889
  TranslationHighlighter.prototype.getKeyAndDefault = function (mouseEvent, element) {
3840
3890
  return __awaiter(this, void 0, void 0, function () {
3841
- var keysWithDefaults, keySet, selectedKey_1, found;
3891
+ var keysWithDefaults, keySet, renderer, selectedKey_1, found;
3842
3892
  return __generator(this, function (_a) {
3843
3893
  switch (_a.label) {
3844
3894
  case 0:
@@ -3850,19 +3900,22 @@ var TranslationHighlighter = /** @class */ (function () {
3850
3900
  }
3851
3901
  keysWithDefaults = TranslationHighlighter.getKeyOptions(element);
3852
3902
  keySet = new Set(keysWithDefaults.map(function (keyWithDefault) { return keyWithDefault.key; }));
3853
- if (!(keySet.size > 1)) return [3 /*break*/, 2];
3854
- return [4 /*yield*/, this.renderer.getKey({
3903
+ if (!(keySet.size > 1)) return [3 /*break*/, 3];
3904
+ return [4 /*yield*/, this.getRenderer()];
3905
+ case 1:
3906
+ renderer = _a.sent();
3907
+ return [4 /*yield*/, renderer.getKey({
3855
3908
  keys: keySet,
3856
3909
  openEvent: mouseEvent,
3857
3910
  })];
3858
- case 1:
3911
+ case 2:
3859
3912
  selectedKey_1 = _a.sent();
3860
3913
  found = keysWithDefaults.find(function (kwd) { return kwd.key === selectedKey_1; });
3861
3914
  if (found) {
3862
3915
  return [2 /*return*/, found];
3863
3916
  }
3864
- _a.label = 2;
3865
- case 2:
3917
+ _a.label = 3;
3918
+ case 3:
3866
3919
  if (keySet.size === 1) {
3867
3920
  return [2 /*return*/, keysWithDefaults[0]];
3868
3921
  }
@@ -3901,10 +3954,12 @@ var ElementRegistrar = /** @class */ (function () {
3901
3954
  try {
3902
3955
  for (var _b = __values(this.registeredElements), _c = _b.next(); !_c.done; _c = _b.next()) {
3903
3956
  var element = _c.value;
3904
- this.cleanElementInactiveNodes(element);
3905
- if (element._tolgee.nodes.size === 0 &&
3906
- !element._tolgee.wrappedWithElementOnlyKey) {
3907
- this.cleanElement(element);
3957
+ if (!element._tolgee.preventClean) {
3958
+ this.cleanElementInactiveNodes(element);
3959
+ if (element._tolgee.nodes.size === 0 &&
3960
+ !element._tolgee.wrappedWithElementOnlyKey) {
3961
+ this.cleanElement(element);
3962
+ }
3908
3963
  }
3909
3964
  }
3910
3965
  }
@@ -3976,12 +4031,14 @@ var ElementRegistrar = /** @class */ (function () {
3976
4031
  }
3977
4032
  };
3978
4033
  ElementRegistrar.prototype.cleanElement = function (element) {
3979
- if (typeof element._tolgee.removeAllEventListeners === 'function') {
3980
- element._tolgee.removeAllEventListeners();
4034
+ if (!element._tolgee.preventClean) {
4035
+ if (typeof element._tolgee.removeAllEventListeners === 'function') {
4036
+ element._tolgee.removeAllEventListeners();
4037
+ }
4038
+ element.removeAttribute(TOLGEE_ATTRIBUTE_NAME);
4039
+ delete element._tolgee;
4040
+ this.registeredElements.delete(element);
3981
4041
  }
3982
- element.removeAttribute(TOLGEE_ATTRIBUTE_NAME);
3983
- delete element._tolgee;
3984
- this.registeredElements.delete(element);
3985
4042
  };
3986
4043
  ElementRegistrar.prototype.getActiveNodes = function (element) {
3987
4044
  var _a, _b, node, e_5_1;
@@ -4271,8 +4328,10 @@ var CoreHandler = /** @class */ (function () {
4271
4328
  this.attributeHandler = attributeHandler;
4272
4329
  this.textService = textService;
4273
4330
  this.wrappedHandler = wrappedHandler;
4274
- eventService.LANGUAGE_CHANGED.subscribe(this.refresh.bind(this));
4275
- eventService.TRANSLATION_CHANGED.subscribe(this.refresh.bind(this));
4331
+ if (typeof window !== 'undefined') {
4332
+ eventService.LANGUAGE_CHANGED.subscribe(this.refresh.bind(this));
4333
+ eventService.TRANSLATION_CHANGED.subscribe(this.refresh.bind(this));
4334
+ }
4276
4335
  }
4277
4336
  CoreHandler.prototype.handleSubtree = function (target) {
4278
4337
  return __awaiter(this, void 0, void 0, function () {