intor 2.2.4 → 2.2.6

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/dist/index.cjs CHANGED
@@ -1,257 +1,14 @@
1
1
  'use strict';
2
2
 
3
- var path = require('path');
4
- var perf_hooks = require('perf_hooks');
5
- var pLimit = require('p-limit');
6
- var fs = require('fs/promises');
7
- var logry = require('logry');
8
3
  var merge = require('lodash.merge');
9
- var Keyv = require('keyv');
10
4
  var intorTranslator = require('intor-translator');
11
5
 
12
6
  function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
13
7
 
14
- var path__default = /*#__PURE__*/_interopDefault(path);
15
- var pLimit__default = /*#__PURE__*/_interopDefault(pLimit);
16
- var fs__default = /*#__PURE__*/_interopDefault(fs);
17
8
  var merge__default = /*#__PURE__*/_interopDefault(merge);
18
- var Keyv__default = /*#__PURE__*/_interopDefault(Keyv);
19
9
 
20
- // src/modules/intor/utils/should-load-messages.ts
21
- var shouldLoadMessages = (loader) => {
22
- if (!loader) return false;
23
- const { type, lazyLoad } = loader;
24
- if (type === "local") return true;
25
- if (lazyLoad) return false;
26
- return true;
27
- };
28
-
29
- // src/modules/config/constants/cache.constants.ts
30
- var DEFAULT_CACHE_OPTIONS = {
31
- enabled: process.env.NODE_ENV === "production",
32
- ttl: 60 * 60 * 1e3
33
- // 1 hour
34
- };
35
-
36
- // src/shared/logger/global-logger-pool.ts
37
- function getGlobalLoggerPool() {
38
- if (!globalThis.__INTOR_LOGGER_POOL__) {
39
- globalThis.__INTOR_LOGGER_POOL__ = /* @__PURE__ */ new Map();
40
- }
41
- return globalThis.__INTOR_LOGGER_POOL__;
42
- }
43
- function clearLoggerPool() {
44
- const pool = getGlobalLoggerPool();
45
- pool.clear();
46
- }
47
-
48
- // src/shared/logger/get-logger.ts
49
- var DEFAULT_FORMATTER_CONFIG = {
50
- node: { meta: { compact: true }, lineBreaksAfter: 1 }
51
- };
52
- function getLogger({
53
- id = "default",
54
- formatterConfig,
55
- preset,
56
- ...options
57
- }) {
58
- const pool = getGlobalLoggerPool();
59
- let logger = pool.get(id);
60
- const useDefault = !formatterConfig && !preset;
61
- if (!logger) {
62
- logger = logry.logry({
63
- id,
64
- formatterConfig: useDefault ? DEFAULT_FORMATTER_CONFIG : formatterConfig,
65
- preset,
66
- ...options
67
- });
68
- pool.set(id, logger);
69
- if (pool.size > 1e3) {
70
- const keys = [...pool.keys()];
71
- for (const key of keys.slice(0, 200)) pool.delete(key);
72
- }
73
- }
74
- return logger;
75
- }
76
-
77
- // src/modules/messages/load-local-messages/read-locale-messages/collect-file-entries/collect-file-entries.ts
78
- async function collectFileEntries({
79
- readdir = fs__default.default.readdir,
80
- limit,
81
- rootDir,
82
- namespaces,
83
- extraOptions: { exts = [".json"], loggerOptions } = {}
84
- }) {
85
- const baseLogger = getLogger({ ...loggerOptions });
86
- const logger = baseLogger.child({ scope: "collect-file-entries" });
87
- const results = [];
88
- const walk = async (currentDir) => {
89
- let entries = [];
90
- try {
91
- entries = await readdir(currentDir, { withFileTypes: true });
92
- } catch (error) {
93
- logger.error(`Error reading directory: ${currentDir}`, { error });
94
- return;
95
- }
96
- const tasks = entries.map(
97
- (entry) => limit(async () => {
98
- const fullPath = path__default.default.join(currentDir, entry.name);
99
- if (entry.isDirectory()) {
100
- await walk(fullPath);
101
- return;
102
- }
103
- if (!exts.some((ext2) => entry.name.endsWith(ext2))) return;
104
- const relativePath = path__default.default.relative(rootDir, fullPath);
105
- const ext = path__default.default.extname(relativePath);
106
- const withoutExt = relativePath.slice(0, -ext.length);
107
- const segments = withoutExt.split(path__default.default.sep).filter(Boolean);
108
- const namespace = segments.at(0);
109
- if (!namespace) return;
110
- if (namespaces && namespace !== "index") {
111
- if (!namespaces.includes(namespace)) return;
112
- }
113
- results.push({
114
- namespace,
115
- fullPath,
116
- relativePath,
117
- segments,
118
- basename: path__default.default.basename(entry.name, ext)
119
- });
120
- })
121
- );
122
- await Promise.all(tasks);
123
- };
124
- await walk(rootDir);
125
- if (logger.core.level === "debug") {
126
- logger.debug("Local message files collected.", {
127
- count: results.length
128
- });
129
- }
130
- logger.trace("Local message files collected.", {
131
- count: results.length,
132
- fileEntries: results.map(({ namespace, relativePath }) => ({
133
- namespace: namespace === "index" ? null : namespace,
134
- relativePath
135
- }))
136
- });
137
- return results;
138
- }
139
-
140
- // src/modules/messages/shared/utils/is-valid-messages.ts
141
- function isPlainObject(value) {
142
- return typeof value === "object" && value !== null && !Array.isArray(value);
143
- }
144
- function isValidMessages(value) {
145
- if (!isPlainObject(value)) return false;
146
- const stack = [value];
147
- while (stack.length > 0) {
148
- const current = stack.pop();
149
- for (const v of Object.values(current)) {
150
- if (typeof v === "string") continue;
151
- if (isPlainObject(v)) {
152
- stack.push(v);
153
- } else {
154
- return false;
155
- }
156
- }
157
- }
158
- return true;
159
- }
160
- async function jsonReader(filePath, readFile = fs__default.default.readFile) {
161
- const raw = await readFile(filePath, "utf8");
162
- const parsed = JSON.parse(raw);
163
- return parsed;
164
- }
165
-
166
- // src/modules/messages/load-local-messages/read-locale-messages/parse-file-entries/utils/nest-object-from-path.ts
167
- function nestObjectFromPath(path5, value) {
168
- let obj = value;
169
- for (let i = path5.length - 1; i >= 0; i--) {
170
- obj = { [path5[i]]: obj };
171
- }
172
- return obj;
173
- }
174
-
175
- // src/modules/messages/load-local-messages/read-locale-messages/parse-file-entries/parse-file-entries.ts
176
- async function parseFileEntries({
177
- fileEntries,
178
- limit,
179
- extraOptions: { messagesReader, loggerOptions } = {}
180
- }) {
181
- const baseLogger = getLogger({ ...loggerOptions });
182
- const logger = baseLogger.child({ scope: "parse-file-entries" });
183
- const parsedFileEntries = [];
184
- const tasks = fileEntries.map(
185
- ({ namespace, segments, basename, fullPath }) => limit(async () => {
186
- try {
187
- const segsWithoutNs = segments.slice(1);
188
- const ext = path__default.default.extname(fullPath);
189
- const json = ext !== ".json" && messagesReader ? await messagesReader(fullPath) : await jsonReader(fullPath);
190
- if (!isValidMessages(json)) {
191
- throw new Error(
192
- "JSON file does not match NamespaceMessages structure"
193
- );
194
- }
195
- const isIndex = basename === "index";
196
- const keyPath = isIndex ? segsWithoutNs.slice(0, -1) : segsWithoutNs;
197
- const nested = nestObjectFromPath(keyPath, json);
198
- parsedFileEntries.push({ namespace, messages: nested });
199
- logger.trace("Parsed file.", { path: fullPath });
200
- } catch (error) {
201
- logger.error("Failed to read or parse file.", {
202
- path: fullPath,
203
- error
204
- });
205
- }
206
- })
207
- );
208
- await Promise.all(tasks);
209
- const result = {};
210
- for (const { namespace, messages } of parsedFileEntries) {
211
- if (namespace === "index") {
212
- merge__default.default(result, messages);
213
- } else {
214
- result[namespace] = merge__default.default(
215
- result[namespace] ?? {},
216
- messages
217
- );
218
- }
219
- }
220
- return result;
221
- }
222
-
223
- // src/modules/messages/load-local-messages/read-locale-messages/read-locale-messages.ts
224
- var readLocaleMessages = async ({
225
- limit,
226
- rootDir = "messages",
227
- locale,
228
- namespaces,
229
- extraOptions: { exts, messagesReader, loggerOptions } = {}
230
- }) => {
231
- const fileEntries = await collectFileEntries({
232
- rootDir: path__default.default.resolve(process.cwd(), rootDir, locale),
233
- namespaces,
234
- limit,
235
- extraOptions: { exts, loggerOptions }
236
- });
237
- const namespaceMessages = await parseFileEntries({
238
- fileEntries,
239
- limit,
240
- extraOptions: { messagesReader, loggerOptions }
241
- });
242
- const localeMessages = { [locale]: namespaceMessages };
243
- return localeMessages;
244
- };
245
- function getGlobalMessagesPool() {
246
- if (!globalThis.__INTOR_MESSAGES_POOL__) {
247
- globalThis.__INTOR_MESSAGES_POOL__ = new Keyv__default.default();
248
- }
249
- return globalThis.__INTOR_MESSAGES_POOL__;
250
- }
251
- function clearMessagesPool() {
252
- const pool = getGlobalMessagesPool();
253
- pool.clear();
254
- }
10
+ // src/shared/constants/prefix-placeholder.ts
11
+ var PREFIX_PLACEHOLDER = "{locale}";
255
12
  var mergeMessages = (staticMessages = {}, loadedMessages = {}) => {
256
13
  if (!loadedMessages) return { ...staticMessages };
257
14
  return merge__default.default({}, staticMessages, loadedMessages);
@@ -276,9 +33,6 @@ var normalizeCacheKey = (key, delimiter = CACHE_KEY_DELIMITER) => {
276
33
  return String(key);
277
34
  };
278
35
 
279
- // src/shared/constants/prefix-placeholder.ts
280
- var PREFIX_PLACEHOLDER = "{locale}";
281
-
282
36
  // src/shared/utils/resolve-namespaces.ts
283
37
  var resolveNamespaces = ({
284
38
  config,
@@ -443,350 +197,34 @@ var standardizePathname = ({
443
197
  return normalizePathname(standardizedPathname);
444
198
  };
445
199
 
446
- // src/modules/messages/load-local-messages/load-local-messages.ts
447
- var loadLocalMessages = async ({
448
- pool = getGlobalMessagesPool(),
449
- rootDir = "messages",
450
- locale,
451
- fallbackLocales,
452
- namespaces,
453
- extraOptions: {
454
- concurrency = 10,
455
- cacheOptions = DEFAULT_CACHE_OPTIONS,
456
- loggerOptions = { id: "default" },
457
- exts,
458
- messagesReader
459
- } = {},
460
- allowCacheWrite = false
461
- }) => {
462
- const baseLogger = getLogger({ ...loggerOptions });
463
- const logger = baseLogger.child({ scope: "load-local-messages" });
464
- const start = perf_hooks.performance.now();
465
- logger.debug("Loading local messages from directory.", {
466
- rootDir,
467
- resolvedRootDir: path__default.default.resolve(process.cwd(), rootDir)
468
- });
469
- const key = normalizeCacheKey([
470
- loggerOptions.id,
471
- "loaderType:local",
472
- rootDir,
473
- locale,
474
- (fallbackLocales || []).toSorted().join(","),
475
- (namespaces || []).toSorted().join(",")
476
- ]);
477
- if (cacheOptions.enabled && key) {
478
- const cached = await pool?.get(key);
479
- if (cached) {
480
- logger.debug("Messages cache hit.", { key });
481
- return cached;
482
- }
200
+ // src/shared/error/intor-error.ts
201
+ var IntorError = class extends Error {
202
+ code;
203
+ id;
204
+ constructor({ message, code, id }) {
205
+ const fullMessage = id ? `[${id}] ${message}` : message;
206
+ super(fullMessage);
207
+ this.name = "IntorError";
208
+ this.id = id;
209
+ this.code = code;
210
+ Object.setPrototypeOf(this, new.target.prototype);
483
211
  }
484
- const limit = pLimit__default.default(concurrency);
485
- const candidateLocales = [locale, ...fallbackLocales || []];
486
- let messages;
487
- for (const candidateLocale of candidateLocales) {
488
- try {
489
- const result = await readLocaleMessages({
490
- limit,
491
- rootDir,
492
- locale: candidateLocale,
493
- namespaces,
494
- extraOptions: { loggerOptions, exts, messagesReader }
495
- });
496
- if (result && Object.values(result[candidateLocale] || {}).length > 0) {
497
- messages = result;
498
- break;
499
- }
500
- } catch (error) {
501
- logger.error("Failed to read locale messages", {
502
- locale: candidateLocale,
503
- error
504
- });
505
- }
506
- }
507
- if (allowCacheWrite && cacheOptions.enabled && key && messages) {
508
- await pool?.set(key, messages, cacheOptions.ttl);
509
- }
510
- const end = perf_hooks.performance.now();
511
- const duration = Math.round(end - start);
512
- logger.trace("Finished loading local messages.", {
513
- loadedLocale: messages ? Object.keys(messages)[0] : void 0,
514
- duration: `${duration} ms`
515
- });
516
- return messages;
517
212
  };
518
-
519
- // src/modules/messages/load-remote-messages/fetch-locale-messages/fetch-locale-messages.ts
520
- var fetchLocaleMessages = async ({
521
- remoteUrl,
522
- remoteHeaders,
523
- searchParams,
524
- locale,
525
- extraOptions: { loggerOptions } = {}
526
- }) => {
527
- const baseLogger = getLogger({ ...loggerOptions });
528
- const logger = baseLogger.child({ scope: "fetch-locale-messages" });
529
- try {
530
- const params = new URLSearchParams(searchParams);
531
- params.append("locale", locale);
532
- const url = `${remoteUrl}?${params.toString()}`;
533
- const headers = {
534
- "Content-Type": "application/json",
535
- ...remoteHeaders
536
- };
537
- const response = await fetch(url, {
538
- method: "GET",
539
- headers,
540
- cache: "no-store"
541
- });
542
- if (!response.ok) {
543
- throw new Error(`HTTP error ${response.status} ${response.statusText}`);
544
- }
545
- const data = await response.json();
546
- if (!isValidMessages(data[locale])) {
547
- throw new Error("JSON file does not match NamespaceMessages structure");
548
- }
549
- return data;
550
- } catch (error) {
551
- logger.warn("Fetching locale messages failed.", {
552
- locale,
553
- remoteUrl,
554
- searchParams: decodeURIComponent(searchParams.toString()),
555
- error
556
- });
557
- return;
558
- }
559
- };
560
-
561
- // src/modules/messages/load-remote-messages/fetch-locale-messages/utils/build-search-params.ts
562
- var buildSearchParams = (params) => {
563
- const searchParams = new URLSearchParams();
564
- const appendParam = (key, value) => {
565
- if (value === void 0 || value === null) return;
566
- if (Array.isArray(value) && value.length === 0) return;
567
- if (Array.isArray(value)) {
568
- value.forEach((v) => v && searchParams.append(key, v));
569
- } else {
570
- searchParams.append(key, value);
571
- }
572
- };
573
- Object.entries(params).forEach(([key, value]) => {
574
- appendParam(key, value);
575
- });
576
- return searchParams;
577
- };
578
-
579
- // src/modules/messages/load-remote-messages/load-remote-messages.ts
580
- var loadRemoteMessages = async ({
581
- pool = getGlobalMessagesPool(),
582
- rootDir,
583
- remoteUrl,
584
- remoteHeaders,
585
- locale,
586
- fallbackLocales = [],
587
- namespaces = [],
588
- extraOptions: {
589
- cacheOptions = DEFAULT_CACHE_OPTIONS,
590
- loggerOptions = { id: "default" }
591
- } = {},
592
- allowCacheWrite
593
- }) => {
594
- const baseLogger = getLogger({ ...loggerOptions });
595
- const logger = baseLogger.child({ scope: "load-remote-messages" });
596
- const start = performance.now();
597
- logger.debug("Loading remote messages from api.", { remoteUrl });
598
- const key = normalizeCacheKey([
599
- loggerOptions.id,
600
- "loaderType:remote",
601
- rootDir,
602
- locale,
603
- (fallbackLocales ?? []).toSorted().join(","),
604
- (namespaces ?? []).toSorted().join(",")
605
- ]);
606
- if (cacheOptions.enabled && key) {
607
- const cached = await pool?.get(key);
608
- if (cached) {
609
- logger.debug("Messages cache hit.", { key });
610
- return cached;
611
- }
612
- }
613
- const searchParams = buildSearchParams({ rootDir, namespaces });
614
- const candidateLocales = [locale, ...fallbackLocales || []];
615
- let messages;
616
- for (const candidateLocale of candidateLocales) {
617
- try {
618
- const result = await fetchLocaleMessages({
619
- remoteUrl,
620
- remoteHeaders,
621
- searchParams,
622
- locale: candidateLocale,
623
- extraOptions: { loggerOptions }
624
- });
625
- if (result && Object.values(result[candidateLocale] || {}).length > 0) {
626
- messages = result;
627
- break;
628
- }
629
- } catch (error) {
630
- logger.error("Failed to fetch locale messages.", {
631
- locale: candidateLocale,
632
- error
633
- });
634
- }
635
- }
636
- if (allowCacheWrite && cacheOptions.enabled && key && messages) {
637
- await pool?.set(key, messages, cacheOptions.ttl);
638
- }
639
- const end = performance.now();
640
- const duration = Math.round(end - start);
641
- logger.trace("Finished loading remote messages.", {
642
- loadedLocale: messages ? Object.keys(messages)[0] : void 0,
643
- duration: `${duration} ms`
644
- });
645
- return messages;
646
- };
647
-
648
- // src/modules/messages/load-messages.ts
649
- var loadMessages = async ({
650
- config,
651
- locale,
652
- pathname = "",
653
- extraOptions: { exts, messagesReader } = {},
654
- allowCacheWrite = false
655
- }) => {
656
- const baseLogger = getLogger({ id: config.id, ...config.logger });
657
- const logger = baseLogger.child({ scope: "load-messages" });
658
- if (!config.loader) {
659
- logger.warn(
660
- "No loader options have been configured in the current config."
661
- );
662
- return;
663
- }
664
- const { type, concurrency, rootDir } = config.loader;
665
- const fallbackLocales = config.fallbackLocales[locale] || [];
666
- const namespaces = resolveNamespaces({ config, pathname });
667
- if (logger.core.level === "debug") {
668
- logger.debug("Starting to load messages.", { locale });
669
- }
670
- logger.trace("Starting to load messages with runtime context.", {
671
- loaderType: type,
672
- locale,
673
- fallbackLocales,
674
- namespaces: namespaces && namespaces.length > 0 ? [...namespaces] : "[ALL]",
675
- cache: config.cache,
676
- concurrency: concurrency ?? 10
677
- });
678
- let loadedMessages;
679
- if (type === "local") {
680
- loadedMessages = await loadLocalMessages({
681
- rootDir,
682
- locale,
683
- fallbackLocales,
684
- namespaces,
685
- extraOptions: {
686
- concurrency,
687
- cacheOptions: config.cache,
688
- loggerOptions: { id: config.id, ...config.logger },
689
- exts,
690
- messagesReader
691
- },
692
- allowCacheWrite
693
- });
694
- } else if (type === "remote") {
695
- loadedMessages = await loadRemoteMessages({
696
- rootDir,
697
- remoteUrl: config.loader.remoteUrl,
698
- remoteHeaders: config.loader.remoteHeaders,
699
- locale,
700
- fallbackLocales,
701
- namespaces,
702
- extraOptions: {
703
- cacheOptions: config.cache,
704
- loggerOptions: { id: config.id, ...config.logger }
705
- }
706
- });
707
- }
708
- if (!loadedMessages || Object.keys(loadedMessages).length === 0) {
709
- logger.warn("No messages found.", { locale, namespaces });
710
- }
711
- return loadedMessages;
712
- };
713
-
714
- // src/modules/intor/intor.ts
715
- var intor = async (config, i18nContext, loadMessagesOptions = {}) => {
716
- const baseLogger = getLogger({ id: config.id, ...config.logger });
717
- const logger = baseLogger.child({ scope: "intor" });
718
- logger.info("Start Intor initialization.");
719
- const { messages, loader } = config;
720
- const isI18nContextFunction = typeof i18nContext === "function";
721
- const context = isI18nContextFunction ? await i18nContext(config) : {
722
- locale: i18nContext?.locale || config.defaultLocale,
723
- pathname: i18nContext?.pathname || ""
724
- };
725
- const { locale, pathname } = context;
726
- const source = isI18nContextFunction ? i18nContext.name : "static fallback";
727
- logger.debug(`I18n context resolved via ${source}.`, context);
728
- let loadedMessages;
729
- if (shouldLoadMessages(loader)) {
730
- loadedMessages = await loadMessages({
731
- config,
732
- locale,
733
- pathname,
734
- extraOptions: {
735
- exts: loadMessagesOptions.exts,
736
- messagesReader: loadMessagesOptions.messagesReader
737
- },
738
- allowCacheWrite: true
739
- });
740
- }
741
- const mergedMessages = mergeMessages(messages, loadedMessages);
742
- logger.info("Messages successfully initialized.", {
743
- static: { enabled: !!messages },
744
- loaded: {
745
- enabled: !!loadedMessages,
746
- ...loader ? { loaderType: loader.type, lazyLoad: !!loader.lazyLoad } : null
747
- },
748
- merged: mergedMessages
749
- });
750
- return {
751
- config,
752
- initialLocale: locale,
753
- pathname,
754
- messages: mergedMessages
755
- };
756
- };
757
- async function getTranslator(opts) {
758
- const { config, locale, pathname = "", preKey, handlers } = opts;
759
- const messages = await loadMessages({ config, locale, pathname });
760
- const translator = new intorTranslator.Translator({
761
- locale,
762
- messages,
763
- fallbackLocales: config.fallbackLocales,
764
- loadingMessage: config.translator?.loadingMessage,
765
- placeholder: config.translator?.placeholder,
766
- handlers
767
- });
768
- const props = { messages, locale };
769
- const scoped = translator.scoped(preKey);
770
- return {
771
- ...props,
772
- hasKey: preKey ? scoped.hasKey : translator.hasKey,
773
- t: preKey ? scoped.t : translator.t
774
- };
775
- }
213
+ var IntorErrorCode = /* @__PURE__ */ ((IntorErrorCode2) => {
214
+ IntorErrorCode2["MISSING_SUPPORTED_LOCALES"] = "INTOR_MISSING_SUPPORTED_LOCALES";
215
+ IntorErrorCode2["MISSING_DEFAULT_LOCALE"] = "INTOR_MISSING_DEFAULT_LOCALE";
216
+ IntorErrorCode2["UNSUPPORTED_DEFAULT_LOCALE"] = "INTOR_UNSUPPORTED_DEFAULT_LOCALE";
217
+ return IntorErrorCode2;
218
+ })(IntorErrorCode || {});
776
219
 
777
220
  Object.defineProperty(exports, "Translator", {
778
221
  enumerable: true,
779
222
  get: function () { return intorTranslator.Translator; }
780
223
  });
224
+ exports.IntorError = IntorError;
225
+ exports.IntorErrorCode = IntorErrorCode;
781
226
  exports.PREFIX_PLACEHOLDER = PREFIX_PLACEHOLDER;
782
- exports.clearLoggerPool = clearLoggerPool;
783
- exports.clearMessagesPool = clearMessagesPool;
784
227
  exports.extractPathname = extractPathname;
785
- exports.getTranslator = getTranslator;
786
- exports.intor = intor;
787
- exports.loadLocalMessages = loadLocalMessages;
788
- exports.loadMessages = loadMessages;
789
- exports.loadRemoteMessages = loadRemoteMessages;
790
228
  exports.mergeMessages = mergeMessages;
791
229
  exports.normalizeCacheKey = normalizeCacheKey;
792
230
  exports.normalizeLocale = normalizeLocale;