gt-react 6.0.10 → 6.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.
@@ -1,4 +1,4 @@
1
- export declare const projectIDMissingError = "gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.";
1
+ export declare const projectIdMissingError = "gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.";
2
2
  export declare const createPluralMissingError: (children: any) => string;
3
3
  export declare const createClientSideTWithoutIDError: (children: any) => string;
4
4
  export declare const createStringTranslationError: (content: string, id?: string) => string;
@@ -1,8 +1,8 @@
1
1
  "use strict";
2
2
  // ---- ERRORS ---- //
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.createNoEntryWarning = exports.createLibraryNoEntryWarning = exports.createNestedDataGTError = exports.createClientSideTHydrationError = exports.createClientSideTDictionaryCollisionError = exports.createStringTranslationError = exports.createClientSideTWithoutIDError = exports.createPluralMissingError = exports.projectIDMissingError = void 0;
5
- exports.projectIDMissingError = 'gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.';
4
+ exports.createNoEntryWarning = exports.createLibraryNoEntryWarning = exports.createNestedDataGTError = exports.createClientSideTHydrationError = exports.createClientSideTDictionaryCollisionError = exports.createStringTranslationError = exports.createClientSideTWithoutIDError = exports.createPluralMissingError = exports.projectIdMissingError = void 0;
5
+ exports.projectIdMissingError = 'gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.';
6
6
  var createPluralMissingError = function (children) { return "<Plural> component with children \"".concat(children, "\" requires \"n\" option."); };
7
7
  exports.createPluralMissingError = createPluralMissingError;
8
8
  var createClientSideTWithoutIDError = function (children) { return "Client-side <T> with no provided 'id' prop. Children: \"".concat(children, "\""); };
@@ -3,7 +3,7 @@ import { Dictionary } from "../types/types";
3
3
  * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
4
4
  *
5
5
  * @param {React.ReactNode} children - The children components that will use the translation context.
6
- * @param {string} [projectID] - The project ID required for General Translation cloud services.
6
+ * @param {string} [projectId] - The project ID required for General Translation cloud services.
7
7
  * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
8
8
  * @param {string[]} [locales] - The list of approved locales for the project.
9
9
  * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
@@ -12,9 +12,9 @@ import { Dictionary } from "../types/types";
12
12
  *
13
13
  * @returns {JSX.Element} The provider component for General Translation context.
14
14
  */
15
- export default function GTProvider({ children, projectID, dictionary, locales, defaultLocale, locale, cacheURL }: {
15
+ export default function GTProvider({ children, projectId, dictionary, locales, defaultLocale, locale, cacheURL }: {
16
16
  children?: any;
17
- projectID?: string;
17
+ projectId?: string;
18
18
  dictionary?: Dictionary;
19
19
  locales?: string[];
20
20
  defaultLocale?: string;
@@ -58,7 +58,7 @@ var createErrors_1 = require("../errors/createErrors");
58
58
  * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
59
59
  *
60
60
  * @param {React.ReactNode} children - The children components that will use the translation context.
61
- * @param {string} [projectID] - The project ID required for General Translation cloud services.
61
+ * @param {string} [projectId] - The project ID required for General Translation cloud services.
62
62
  * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
63
63
  * @param {string[]} [locales] - The list of approved locales for the project.
64
64
  * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
@@ -69,9 +69,9 @@ var createErrors_1 = require("../errors/createErrors");
69
69
  */
70
70
  function GTProvider(_a) {
71
71
  var _this = this;
72
- var children = _a.children, projectID = _a.projectID, _b = _a.dictionary, dictionary = _b === void 0 ? {} : _b, locales = _a.locales, _c = _a.defaultLocale, defaultLocale = _c === void 0 ? (locales === null || locales === void 0 ? void 0 : locales[0]) || internal_2.libraryDefaultLocale : _c, locale = _a.locale, _d = _a.cacheURL, cacheURL = _d === void 0 ? internal_2.defaultCacheURL : _d;
73
- if (!projectID && cacheURL === internal_2.defaultCacheURL) {
74
- throw new Error(createErrors_1.projectIDMissingError);
72
+ var children = _a.children, projectId = _a.projectId, _b = _a.dictionary, dictionary = _b === void 0 ? {} : _b, locales = _a.locales, _c = _a.defaultLocale, defaultLocale = _c === void 0 ? (locales === null || locales === void 0 ? void 0 : locales[0]) || internal_2.libraryDefaultLocale : _c, locale = _a.locale, _d = _a.cacheURL, cacheURL = _d === void 0 ? internal_2.defaultCacheURL : _d;
73
+ if (!projectId && cacheURL === internal_2.defaultCacheURL) {
74
+ throw new Error(createErrors_1.projectIdMissingError);
75
75
  }
76
76
  var browserLocale = (0, useBrowserLocale_1.default)(defaultLocale, locales);
77
77
  locale = locale || browserLocale;
@@ -90,7 +90,7 @@ function GTProvider(_a) {
90
90
  var response, result;
91
91
  return __generator(this, function (_a) {
92
92
  switch (_a.label) {
93
- case 0: return [4 /*yield*/, fetch("".concat(cacheURL, "/").concat(projectID, "/").concat(locale))];
93
+ case 0: return [4 /*yield*/, fetch("".concat(cacheURL, "/").concat(projectId, "/").concat(locale))];
94
94
  case 1:
95
95
  response = _a.sent();
96
96
  return [4 /*yield*/, response.json()];
@@ -165,7 +165,7 @@ function GTProvider(_a) {
165
165
  defaultLocale: defaultLocale,
166
166
  translations: translations,
167
167
  translationRequired: translationRequired,
168
- projectID: projectID
168
+ projectId: projectId
169
169
  }, children: children }));
170
170
  }
171
171
  //# sourceMappingURL=GTProvider.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"GTProvider.js","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,6BA8HC;;AA5JD,+BAAuC;AACvC,yDAAiG;AACjG,+BAAuE;AACvE,+EAAyD;AAEzD,yCAAwC;AAExC,oFAA8D;AAC9D,wCAA8C;AAC9C,wFAAkE;AAClE,4FAAsE;AACtE,kGAA4E;AAE5E,wDAAoF;AACpF,8EAAwD;AACxD,uDAAkH;AAElH;;;;;;;;;;;;GAYG;AACH,SAAwB,UAAU,CAAC,EAgBlC;IAhBD,iBA8HC;QA7HG,QAAQ,cAAA,EACR,SAAS,eAAA,EACT,kBAAe,EAAf,UAAU,mBAAG,EAAE,KAAA,EACf,OAAO,aAAA,EACP,qBAAoD,EAApD,aAAa,mBAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,KAAI,+BAAoB,KAAA,EACpD,MAAM,YAAA,EACN,gBAA0B,EAA1B,QAAQ,mBAAG,0BAAe,KAAA;IAW1B,IAAI,CAAC,SAAS,IAAI,QAAQ,KAAK,0BAAe,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,oCAAqB,CAAC,CAAA;IAC1C,CAAC;IAED,IAAM,aAAa,GAAG,IAAA,0BAAgB,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;IACjC,IAAI,OAAO,EAAE,CAAC;QACV,MAAM,GAAG,IAAA,oCAAe,EAAC,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC;IACzE,CAAC;IAED,IAAM,mBAAmB,GAAG,IAAA,eAAO,EAAC,cAAM,OAAA,IAAA,wCAAmB,EAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAnD,CAAmD,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAE1H,IAAA,KAAkC,IAAA,gBAAQ,EAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACvB,EAFM,YAAY,QAAA,EAAE,eAAe,QAEnC,CAAA;IAED,IAAA,iBAAS,EAAC;QACN,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACvB,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B;YACnD,CAAC;iBAAM,CAAC;gBACJ,CAAC;;;;oCACoB,qBAAM,KAAK,CAAC,UAAG,QAAQ,cAAI,SAAS,cAAI,MAAM,CAAE,CAAC,EAAA;;gCAA5D,QAAQ,GAAG,SAAiD;gCACnD,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;gCAA9B,MAAM,GAAG,SAAqB;gCACpC,eAAe,CAAC,MAAM,CAAC,CAAC;;;;qBAC3B,CAAC,EAAE,CAAA;YACR,CAAC;QACL,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAEvC,IAAM,SAAS,GAAG,IAAA,mBAAW,EAAC,UAC1B,EAAU,EACV,OAAiC,EACjC,CAAY;QADZ,wBAAA,EAAA,YAAiC;QAIjC,2BAA2B;QACvB,IAAA,KAAsB,IAAA,8BAAoB,EAC1C,IAAA,4BAAkB,EAAC,UAAU,EAAE,EAAE,CAAoB,CACxD,EAFK,KAAK,WAAA,EAAE,QAAQ,cAEpB,CAAC;QAEF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,IAAA,0CAA2B,EAAC,EAAE,CAAC,CAAC,CAAA;YAC7C,OAAO,SAAS,CAAC;QACrB,CAAC;QAAA,CAAC;QAEF,qCAAqC;QACrC,IAAI,SAAS,CAAC;QAAC,IAAI,gBAAgB,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACV,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,EAAE,CAAC;gBAC7B,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC;YACjD,CAAC;QACL,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC1B,KAAK,GAAG,CAAC,CAAC,OAAO,CAAiB,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAiB,CAAC;QAC3C,CAAC;QAED,IAAM,WAAW,GAAG,IAAA,0BAAe,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE/C,kCAAkC;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,EAAE,aAAa,EAC1B,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,+BAAqB,EAAC;gBACzB,QAAQ,EAAE,WAAW;gBAAE,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;gBAAE,aAAa,eAAA;gBACjE,cAAc,0BAAA;aACjB,CAAC,CAAA;QACN,CAAC;QAED,+BAA+B;QAC/B,IAAI,YAAY,EAAE,CAAC;YACf,IAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,CAAC,CAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAC7C,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,kCAAwB,EAAC;gBAC5B,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,WAAW,CAAC,CAAC;gBACrB,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;gBAC3B,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC;gBAChC,cAAc,0BAAA;aACjB,CAAC,CAAC;QACP,CAAC;IACL,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;IAEnE,OAAO,CACH,uBAAC,qBAAS,CAAC,QAAQ,IAAC,KAAK,EAAE;YACvB,SAAS,WAAA;YACT,MAAM,QAAA;YAAE,aAAa,eAAA;YACrB,YAAY,cAAA;YAAE,mBAAmB,qBAAA;YACjC,SAAS,WAAA;SACZ,YACI,QAAQ,GACQ,CACxB,CAAA;AAEL,CAAC"}
1
+ {"version":3,"file":"GTProvider.js","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,6BA8HC;;AA5JD,+BAAuC;AACvC,yDAAiG;AACjG,+BAAuE;AACvE,+EAAyD;AAEzD,yCAAwC;AAExC,oFAA8D;AAC9D,wCAA8C;AAC9C,wFAAkE;AAClE,4FAAsE;AACtE,kGAA4E;AAE5E,wDAAoF;AACpF,8EAAwD;AACxD,uDAA4F;AAE5F;;;;;;;;;;;;GAYG;AACH,SAAwB,UAAU,CAAC,EAgBlC;IAhBD,iBA8HC;QA7HG,QAAQ,cAAA,EACR,SAAS,eAAA,EACT,kBAAe,EAAf,UAAU,mBAAG,EAAE,KAAA,EACf,OAAO,aAAA,EACP,qBAAoD,EAApD,aAAa,mBAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,CAAC,CAAC,KAAI,+BAAoB,KAAA,EACpD,MAAM,YAAA,EACN,gBAA0B,EAA1B,QAAQ,mBAAG,0BAAe,KAAA;IAW1B,IAAI,CAAC,SAAS,IAAI,QAAQ,KAAK,0BAAe,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,oCAAqB,CAAC,CAAA;IAC1C,CAAC;IAED,IAAM,aAAa,GAAG,IAAA,0BAAgB,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;IACjC,IAAI,OAAO,EAAE,CAAC;QACV,MAAM,GAAG,IAAA,oCAAe,EAAC,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC;IACzE,CAAC;IAED,IAAM,mBAAmB,GAAG,IAAA,eAAO,EAAC,cAAM,OAAA,IAAA,wCAAmB,EAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAnD,CAAmD,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAE1H,IAAA,KAAkC,IAAA,gBAAQ,EAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACvB,EAFM,YAAY,QAAA,EAAE,eAAe,QAEnC,CAAA;IAED,IAAA,iBAAS,EAAC;QACN,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACvB,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B;YACnD,CAAC;iBAAM,CAAC;gBACJ,CAAC;;;;oCACoB,qBAAM,KAAK,CAAC,UAAG,QAAQ,cAAI,SAAS,cAAI,MAAM,CAAE,CAAC,EAAA;;gCAA5D,QAAQ,GAAG,SAAiD;gCACnD,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;gCAA9B,MAAM,GAAG,SAAqB;gCACpC,eAAe,CAAC,MAAM,CAAC,CAAC;;;;qBAC3B,CAAC,EAAE,CAAA;YACR,CAAC;QACL,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAEvC,IAAM,SAAS,GAAG,IAAA,mBAAW,EAAC,UAC1B,EAAU,EACV,OAAiC,EACjC,CAAY;QADZ,wBAAA,EAAA,YAAiC;QAIjC,2BAA2B;QACvB,IAAA,KAAsB,IAAA,8BAAoB,EAC1C,IAAA,4BAAkB,EAAC,UAAU,EAAE,EAAE,CAAoB,CACxD,EAFK,KAAK,WAAA,EAAE,QAAQ,cAEpB,CAAC;QAEF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,IAAA,0CAA2B,EAAC,EAAE,CAAC,CAAC,CAAA;YAC7C,OAAO,SAAS,CAAC;QACrB,CAAC;QAAA,CAAC;QAEF,qCAAqC;QACrC,IAAI,SAAS,CAAC;QAAC,IAAI,gBAAgB,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACV,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,EAAE,CAAC;gBAC7B,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC;YACjD,CAAC;QACL,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC1B,KAAK,GAAG,CAAC,CAAC,OAAO,CAAiB,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAiB,CAAC;QAC3C,CAAC;QAED,IAAM,WAAW,GAAG,IAAA,0BAAe,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE/C,kCAAkC;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,EAAE,aAAa,EAC1B,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,+BAAqB,EAAC;gBACzB,QAAQ,EAAE,WAAW;gBAAE,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;gBAAE,aAAa,eAAA;gBACjE,cAAc,0BAAA;aACjB,CAAC,CAAA;QACN,CAAC;QAED,+BAA+B;QAC/B,IAAI,YAAY,EAAE,CAAC;YACf,IAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,CAAC,CAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAC7C,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,kCAAwB,EAAC;gBAC5B,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,WAAW,CAAC,CAAC;gBACrB,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;gBAC3B,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC;gBAChC,cAAc,0BAAA;aACjB,CAAC,CAAC;QACP,CAAC;IACL,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;IAEnE,OAAO,CACH,uBAAC,qBAAS,CAAC,QAAQ,IAAC,KAAK,EAAE;YACvB,SAAS,WAAA;YACT,MAAM,QAAA;YAAE,aAAa,eAAA;YACrB,YAAY,cAAA;YAAE,mBAAmB,qBAAA;YACjC,SAAS,WAAA;SACZ,YACI,QAAQ,GACQ,CACxB,CAAA;AAEL,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gt-react",
3
- "version": "6.0.10",
3
+ "version": "6.1.0",
4
4
  "description": "A React library for automatic internationalization.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -28,7 +28,7 @@
28
28
  "@types/node": "^20.14.9",
29
29
  "@types/react": "^18.3.3",
30
30
  "@types/react-dom": "^18.3.0",
31
- "gt-react-cli": "^0.1.2",
31
+ "gt-react-cli": "^0.2.0",
32
32
  "typescript": "^5.5.2"
33
33
  },
34
34
  "exports": {
@@ -74,6 +74,6 @@
74
74
  "i18n"
75
75
  ],
76
76
  "dependencies": {
77
- "generaltranslation": "^4.0.2"
77
+ "generaltranslation": "^4.1.0"
78
78
  }
79
79
  }