@magic-translate/react 1.8.1 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.9.0](https://github.com/magic-translate/magic-translate-react/compare/v1.8.1...v1.9.0) (2023-07-05)
+
+
+### Features
+
+* implement translation hook ([705175b](https://github.com/magic-translate/magic-translate-react/commit/705175bee5d94c99027f27612c3017bcace59958))
+
 ## [1.8.1](https://github.com/magic-translate/magic-translate-react/compare/v1.8.0...v1.8.1) (2023-07-05)
 
 

package/dist/hooks/use-translate.d.ts

@@ -0,0 +1,4 @@
+import { DataLoaderLoadParams } from '../api/data-loader';
+export declare function useTranslate(): (text: string, params?: Omit<DataLoaderLoadParams, 'text'>) => string;
+export declare const useT: typeof useTranslate;
+//# sourceMappingURL=use-translate.d.ts.map

package/dist/hooks/use-translate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-translate.d.ts","sourceRoot":"","sources":["../../src/hooks/use-translate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,wBAAgB,YAAY,IAAI,CAC9B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,KACxC,MAAM,CAeV;AAED,eAAO,MAAM,IAAI,qBAAe,CAAC"}

package/dist/hooks/use-translate.js

@@ -0,0 +1,27 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { useMagicTranslate } from './use-magic-translate';
+import { useCallback, useState } from 'react';
+export function useTranslate() {
+    var dataLoader = useMagicTranslate().dataLoader;
+    var _a = useState(), translation = _a[0], setTranslation = _a[1];
+    return useCallback(function (text, params) {
+        if (params === void 0) { params = {}; }
+        // Yes, I'm basically making an API call in a render function here 😱
+        // But I know what I'm doing. It's ok because of the magic that is
+        // DataLoader: We will only make the request once and cache the result
+        dataLoader.load(__assign({ text: text }, params)).then(setTranslation);
+        return translation !== null && translation !== void 0 ? translation : text;
+    }, [dataLoader, translation]);
+}
+export var useT = useTranslate;
+//# sourceMappingURL=use-translate.js.map

package/dist/hooks/use-translate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-translate.js","sourceRoot":"","sources":["../../src/hooks/use-translate.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG9C,MAAM,UAAU,YAAY;IAIlB,IAAA,UAAU,GAAK,iBAAiB,EAAE,WAAxB,CAAyB;IACrC,IAAA,KAAgC,QAAQ,EAAU,EAAjD,WAAW,QAAA,EAAE,cAAc,QAAsB,CAAC;IAEzD,OAAO,WAAW,CAChB,UAAC,IAAY,EAAE,MAA+C;QAA/C,uBAAA,EAAA,WAA+C;QAC5D,qEAAqE;QACrE,kEAAkE;QAClE,sEAAsE;QACtE,UAAU,CAAC,IAAI,YAAG,IAAI,MAAA,IAAK,MAAM,EAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE1D,OAAO,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,IAAI,CAAC;IAC7B,CAAC,EACD,CAAC,UAAU,EAAE,WAAW,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,IAAM,IAAI,GAAG,YAAY,CAAC"}

package/dist/hooks/use-translate.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=use-translate.test.d.ts.map

package/dist/hooks/use-translate.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-translate.test.d.ts","sourceRoot":"","sources":["../../src/hooks/use-translate.test.tsx"],"names":[],"mappings":""}

package/dist/hooks/use-translate.test.js

@@ -0,0 +1,133 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { act, renderHook } from '@testing-library/react';
+import { MagicTranslateProvider } from '../context/MagicTranslateContext';
+import React from 'react';
+import { Language } from '../domain/language';
+import { useTranslate } from './use-translate';
+var tick = function () { return new Promise(function (resolve) { return setTimeout(resolve); }); };
+var ExampleComponent = function () { return React.createElement(React.Fragment, null, "Some component"); };
+ExampleComponent.displayName = 'ExampleComponent';
+describe('Translate', function () {
+    var lang = Language.DE;
+    var mockFn = jest.fn();
+    var loader = function () { return function (content) {
+        // for some reason when using the mock directly the mock is not called. This is a workaround
+        mockFn(content);
+        return Promise.resolve(content.map(function (item) { return "Translated: ".concat(item.text); }));
+    }; };
+    var wrapper = function (_a) {
+        var children = _a.children;
+        return (React.createElement(MagicTranslateProvider, { _loaderFactory: loader, language: lang, apiKey: "test-api-key" }, children));
+    };
+    afterEach(function () {
+        mockFn.mockReset();
+    });
+    it('should call the loader with the content', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    result = renderHook(function () { return useTranslate(); }, { wrapper: wrapper }).result;
+                    // when
+                    act(function () {
+                        result.current('test');
+                    });
+                    return [4 /*yield*/, tick()];
+                case 1:
+                    _a.sent();
+                    // then
+                    expect(mockFn).toHaveBeenCalledWith([{ text: 'test' }]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should call the loader with the content and formality', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    result = renderHook(function () { return useTranslate(); }, { wrapper: wrapper }).result;
+                    // when
+                    act(function () {
+                        result.current('test', { formality: 'formal' });
+                    });
+                    return [4 /*yield*/, tick()];
+                case 1:
+                    _a.sent();
+                    // then
+                    expect(mockFn).toHaveBeenCalledWith([
+                        { text: 'test', formality: 'formal' },
+                    ]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return the translation', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result, translation;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    result = renderHook(function () { return useTranslate(); }, { wrapper: wrapper }).result;
+                    translation = null;
+                    return [4 /*yield*/, act(function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                result.current('test');
+                                return [2 /*return*/];
+                            });
+                        }); })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, tick()];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, act(function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                translation = result.current('test');
+                                return [2 /*return*/];
+                            });
+                        }); })];
+                case 3:
+                    _a.sent();
+                    // then
+                    expect(translation).toBe('Translated: test');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=use-translate.test.js.map

package/dist/hooks/use-translate.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-translate.test.js","sourceRoot":"","sources":["../../src/hooks/use-translate.test.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAA4B,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,IAAM,IAAI,GAAG,cAAM,OAAA,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,CAAC,EAAnB,CAAmB,CAAC,EAA7C,CAA6C,CAAC;AAEjE,IAAM,gBAAgB,GAAG,cAAM,OAAA,2DAAmB,EAAnB,CAAmB,CAAC;AACnD,gBAAgB,CAAC,WAAW,GAAG,kBAAkB,CAAC;AAElD,QAAQ,CAAC,WAAW,EAAE;IACpB,IAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC;IACzB,IAAM,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEzB,IAAM,MAAM,GAAG,cAAM,OAAA,UAAC,OAAwC;QAC5D,4FAA4F;QAC5F,MAAM,CAAC,OAAO,CAAC,CAAC;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,sBAAe,IAAI,CAAC,IAAI,CAAE,EAA1B,CAA0B,CAAC,CAAC,CAAC;IAC5E,CAAC,EAJoB,CAIpB,CAAC;IAEF,IAAM,OAAO,GAA+C,UAAC,EAE5D;YADC,QAAQ,cAAA;QACJ,OAAA,CACJ,oBAAC,sBAAsB,IACrB,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,IAAI,EACd,MAAM,EAAC,cAAc,IAEpB,QAAQ,CACc,CAC1B;IARK,CAQL,CAAC;IAEF,SAAS,CAAC;QACR,MAAM,CAAC,SAAS,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE;;;;;oBAEpC,MAAM,GAAK,UAAU,CAAC,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,OAAlD,CAAmD;oBAEjE,OAAO;oBACP,GAAG,CAAC;wBACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;oBACzB,CAAC,CAAC,CAAC;oBACH,qBAAM,IAAI,EAAE,EAAA;;oBAAZ,SAAY,CAAC;oBAEb,OAAO;oBACP,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;;;;SACzD,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE;;;;;oBAElD,MAAM,GAAK,UAAU,CAAC,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,OAAlD,CAAmD;oBAEjE,OAAO;oBACP,GAAG,CAAC;wBACF,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;oBAClD,CAAC,CAAC,CAAC;oBACH,qBAAM,IAAI,EAAE,EAAA;;oBAAZ,SAAY,CAAC;oBAEb,OAAO;oBACP,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC;wBAClC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE;qBACtC,CAAC,CAAC;;;;SACJ,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE;;;;;oBAE1B,MAAM,GAAK,UAAU,CAAC,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,OAAlD,CAAmD;oBAE7D,WAAW,GAAkB,IAAI,CAAC;oBACtC,qBAAM,GAAG,CAAC;;gCACR,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;;;6BACxB,CAAC,EAAA;;oBAFF,SAEE,CAAC;oBACH,qBAAM,IAAI,EAAE,EAAA;;oBAAZ,SAAY,CAAC;oBAEb,qBAAM,GAAG,CAAC;;gCACR,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;;;6BACtC,CAAC,EAAA;;oBAFF,SAEE,CAAC;oBAEH,OAAO;oBACP,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;;;;SAC9C,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -3,4 +3,5 @@ export * from './context/MagicTranslateContext';
 export * from './api/data-loader';
 export { Language } from './domain/language';
 export * from './utils/uts-locale-to-language';
+export * from './hooks/use-translate';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC"}