intor 2.4.6 → 2.4.8

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 (70) hide show
  1. package/dist/core/export/server/index.js +2 -3
  2. package/dist/core/src/routing/pathname/localize-pathname.js +1 -1
  3. package/dist/core/src/server/helpers/get-translator.js +3 -2
  4. package/dist/core/src/server/intor/intor.js +1 -1
  5. package/dist/core/src/server/translator/init-translator.js +6 -3
  6. package/dist/express/src/adapters/express/get-translator.js +5 -4
  7. package/dist/express/src/routing/pathname/localize-pathname.js +1 -1
  8. package/dist/express/src/server/helpers/get-translator.js +3 -2
  9. package/dist/express/src/server/translator/init-translator.js +6 -3
  10. package/dist/fastify/src/adapters/fastify/get-translator.js +5 -4
  11. package/dist/fastify/src/routing/pathname/localize-pathname.js +1 -1
  12. package/dist/fastify/src/server/helpers/get-translator.js +3 -2
  13. package/dist/fastify/src/server/translator/init-translator.js +6 -3
  14. package/dist/hono/src/routing/pathname/localize-pathname.js +1 -1
  15. package/dist/next/src/adapters/next/server/get-translator.js +5 -4
  16. package/dist/next/src/routing/pathname/localize-pathname.js +1 -1
  17. package/dist/next/src/server/helpers/get-translator.js +3 -2
  18. package/dist/next/src/server/intor/intor.js +1 -1
  19. package/dist/next/src/server/translator/init-translator.js +6 -3
  20. package/dist/svelte-kit/export/svelte-kit/index.js +1 -0
  21. package/dist/svelte-kit/src/adapters/svelte-kit/{server/create-intor-handler.js → create-intor-handler.js} +4 -4
  22. package/dist/svelte-kit/src/core/utils/resolve-loader-options.js +1 -5
  23. package/dist/svelte-kit/src/policies/shoud-full-reload.js +1 -1
  24. package/dist/svelte-kit/src/routing/pathname/localize-pathname.js +1 -1
  25. package/dist/types/export/server/index.d.ts +1 -1
  26. package/dist/types/export/svelte-kit/index.d.ts +1 -1
  27. package/dist/types/src/adapters/next/server/get-translator.d.ts +1 -1
  28. package/dist/types/src/adapters/svelte-kit/{server/create-intor-handler.d.ts → create-intor-handler.d.ts} +1 -1
  29. package/dist/types/src/adapters/svelte-kit/index.d.ts +1 -0
  30. package/dist/types/src/client/react/helpers/use-intor.d.ts +1 -2
  31. package/dist/types/src/client/react/provider/intor-provider.d.ts +1 -2
  32. package/dist/types/src/client/react/provider/types.d.ts +10 -11
  33. package/dist/types/src/client/react/provider/use-intor-context.d.ts +1 -2
  34. package/dist/types/src/routing/index.d.ts +1 -1
  35. package/dist/types/src/routing/pathname/localize-pathname.d.ts +1 -1
  36. package/dist/types/src/server/helpers/get-translator.d.ts +2 -0
  37. package/dist/types/src/server/index.d.ts +2 -1
  38. package/dist/types/src/server/intor/intor.d.ts +2 -3
  39. package/dist/types/src/server/translator/index.d.ts +1 -0
  40. package/dist/types/src/server/translator/init-translator.d.ts +2 -0
  41. package/dist/types/src/server/translator/types.d.ts +9 -0
  42. package/package.json +1 -5
  43. package/dist/svelte-kit/export/svelte-kit/server/index.js +0 -2
  44. package/dist/svelte-kit/src/adapters/svelte-kit/server/intor.js +0 -24
  45. package/dist/svelte-kit/src/core/logger/get-logger.js +0 -39
  46. package/dist/svelte-kit/src/core/logger/global-logger-pool.js +0 -8
  47. package/dist/svelte-kit/src/core/messages/load-remote-messages/collect-remote-resources.js +0 -25
  48. package/dist/svelte-kit/src/core/messages/load-remote-messages/fetch-remote-resource.js +0 -47
  49. package/dist/svelte-kit/src/core/messages/load-remote-messages/load-remote-messages.js +0 -93
  50. package/dist/svelte-kit/src/core/messages/load-remote-messages/resolve-remote-resources.js +0 -24
  51. package/dist/svelte-kit/src/core/messages/merge-messages.js +0 -33
  52. package/dist/svelte-kit/src/core/messages/utils/is-valid-messages.js +0 -44
  53. package/dist/svelte-kit/src/core/messages/utils/nest-object-from-path.js +0 -21
  54. package/dist/svelte-kit/src/core/translator/create-translator.js +0 -30
  55. package/dist/svelte-kit/src/core/utils/deep-merge.js +0 -47
  56. package/dist/svelte-kit/src/core/utils/normalizers/normalize-cache-key.js +0 -45
  57. package/dist/svelte-kit/src/server/intor/intor.js +0 -32
  58. package/dist/svelte-kit/src/server/messages/load-local-messages/cache/messages-pool.js +0 -11
  59. package/dist/svelte-kit/src/server/messages/load-local-messages/load-local-messages.js +0 -108
  60. package/dist/svelte-kit/src/server/messages/load-local-messages/read-locale-messages/collect-file-entries/collect-file-entries.js +0 -91
  61. package/dist/svelte-kit/src/server/messages/load-local-messages/read-locale-messages/parse-file-entries/parse-file-entries.js +0 -103
  62. package/dist/svelte-kit/src/server/messages/load-local-messages/read-locale-messages/parse-file-entries/utils/json-reader.js +0 -12
  63. package/dist/svelte-kit/src/server/messages/load-local-messages/read-locale-messages/read-locale-messages.js +0 -42
  64. package/dist/svelte-kit/src/server/messages/load-messages.js +0 -78
  65. package/dist/svelte-kit/src/server/translator/init-translator.js +0 -36
  66. package/dist/types/export/svelte-kit/server/index.d.ts +0 -1
  67. package/dist/types/src/adapters/svelte-kit/server/index.d.ts +0 -2
  68. package/dist/types/src/adapters/svelte-kit/server/intor.d.ts +0 -20
  69. /package/dist/svelte-kit/src/adapters/svelte-kit/{server/utils → utils}/is-svelte-kit-ssg.js +0 -0
  70. /package/dist/types/src/adapters/svelte-kit/{server/utils → utils}/is-svelte-kit-ssg.d.ts +0 -0
@@ -1,91 +0,0 @@
1
- import fs from 'node:fs/promises';
2
- import path from 'node:path';
3
- import '../../../../../core/error/intor-error.js';
4
- import { getLogger } from '../../../../../core/logger/get-logger.js';
5
- import 'p-limit';
6
- import 'intor-translator';
7
-
8
- /**
9
- * Recursively collects message file metadata under a given locale root.
10
- *
11
- * - Traverses directories and collects matching message files
12
- * - Supports filtering by file extensions and optional namespaces
13
- *
14
- * @example
15
- * ```ts
16
- * [{
17
- * namespace: "auth", // If messages under locale root (no namespace) -> "index"
18
- * fullPath: "/Users/john/my-app/messages/en-US/auth/login.json",
19
- * relativePath: "auth/login.json",
20
- * segments: ["auth", "login"],
21
- * basename: "login",
22
- * }, ... ];
23
- * ```
24
- */
25
- async function collectFileEntries({ readdir = fs.readdir, namespaces, rootDir, limit, exts = [], loggerOptions, }) {
26
- const baseLogger = getLogger(loggerOptions);
27
- const logger = baseLogger.child({ scope: "collect-file-entries" });
28
- const supportedExts = new Set(["json", ...exts]);
29
- const fileEntries = [];
30
- // Recursive directory walk
31
- const walk = async (currentDir) => {
32
- // -------------------------------------------------------------------------
33
- // Read directory entries
34
- // -------------------------------------------------------------------------
35
- let entries = [];
36
- try {
37
- entries = await readdir(currentDir, { withFileTypes: true });
38
- }
39
- catch {
40
- logger.debug("Locale directory not found, skipping locale.", {
41
- localeDir: currentDir,
42
- });
43
- return;
44
- }
45
- // -------------------------------------------------------------------------
46
- // 1. Recurse into sub-directories (control flow, no limit)
47
- // -------------------------------------------------------------------------
48
- for (const entry of entries) {
49
- if (!entry.isDirectory())
50
- continue;
51
- await walk(path.join(currentDir, entry.name));
52
- }
53
- // -------------------------------------------------------------------------
54
- // 2. Process files (IO-bound, concurrency-limited)
55
- // -------------------------------------------------------------------------
56
- const tasks = entries
57
- .filter((entry) => entry.isFile())
58
- .map((entry) => limit(async () => {
59
- const fullPath = path.join(currentDir, entry.name);
60
- const ext = path.extname(entry.name).slice(1);
61
- if (!ext || !supportedExts.has(ext))
62
- return;
63
- const relativePath = path.relative(rootDir, fullPath);
64
- const withoutExt = relativePath.slice(0, relativePath.length - (ext.length + 1));
65
- const segments = withoutExt.split(path.sep).filter(Boolean);
66
- const namespace = segments.at(0);
67
- if (!namespace)
68
- return;
69
- // Apply namespace filter (always allow "index")
70
- if (namespaces && namespace !== "index") {
71
- if (!namespaces.includes(namespace))
72
- return;
73
- }
74
- fileEntries.push({
75
- namespace,
76
- fullPath,
77
- relativePath,
78
- segments,
79
- basename: path.basename(entry.name, `.${ext}`),
80
- });
81
- }));
82
- await Promise.all(tasks);
83
- };
84
- await walk(rootDir);
85
- if (fileEntries.length > 0) {
86
- logger.trace(`Collected ${fileEntries.length} local message files for locale "${path.basename(rootDir)}".`);
87
- }
88
- return fileEntries;
89
- }
90
-
91
- export { collectFileEntries };
@@ -1,103 +0,0 @@
1
- import path from 'node:path';
2
- import '../../../../../core/error/intor-error.js';
3
- import { deepMerge } from '../../../../../core/utils/deep-merge.js';
4
- import { getLogger } from '../../../../../core/logger/get-logger.js';
5
- import 'p-limit';
6
- import { isValidMessages } from '../../../../../core/messages/utils/is-valid-messages.js';
7
- import { nestObjectFromPath } from '../../../../../core/messages/utils/nest-object-from-path.js';
8
- import 'intor-translator';
9
- import { jsonReader } from './utils/json-reader.js';
10
-
11
- /**
12
- * Parse locale message files into a unified Messages object (single-locale).
13
- *
14
- * - Reads JSON or custom formats (via `messagesReader`)
15
- * - Validates message structure
16
- * - Builds nested objects based on file path segments
17
- * - Deep-merges entries by namespace
18
- *
19
- * @example
20
- * ```plain
21
- * File paths:
22
- * - en/index.json = { a: "A" }
23
- * - en/ui.json = { b: "B" }
24
- * - en/auth/index.json = { c: "C" }
25
- * - en/auth/verify.json = { d: "D" }
26
- *```
27
-
28
- * The final return value is a `Messages` object:
29
- * ```ts
30
- * {
31
- * a: "A",
32
- * ui: { b: "B" },
33
- * auth: {
34
- * c: "C",
35
- * verify: { d: "D" },
36
- * },
37
- * }
38
- * ```
39
- */
40
- async function parseFileEntries({ fileEntries, limit, readers, loggerOptions, }) {
41
- const baseLogger = getLogger(loggerOptions);
42
- const logger = baseLogger.child({ scope: "parse-file-entries" });
43
- // Read and parse all file entries
44
- const parsedFileEntries = [];
45
- const tasks = fileEntries.map(({ namespace, segments, basename, fullPath }) => limit(async () => {
46
- try {
47
- // -------------------------------------------------------------------
48
- // Read and validate file content
49
- // -------------------------------------------------------------------
50
- const ext = path.extname(fullPath).slice(1); // remove dot
51
- let raw;
52
- if (ext === "json") {
53
- raw = await jsonReader(fullPath);
54
- }
55
- else {
56
- const reader = readers?.[ext];
57
- if (!reader) {
58
- throw new Error(`No message reader registered for .${ext} files. ` +
59
- `Please register a reader for the "${ext}" extension.`);
60
- }
61
- raw = await reader(fullPath);
62
- }
63
- // Validate messages structure
64
- if (!isValidMessages(raw)) {
65
- throw new Error("Parsed content does not match expected Messages structure");
66
- }
67
- // -------------------------------------------------------------------
68
- // Build nested message object from path segments
69
- // -------------------------------------------------------------------
70
- const segmentsWithoutNamespace = segments.slice(1);
71
- const isIndexFile = basename === "index";
72
- const keyPath = isIndexFile
73
- ? segmentsWithoutNamespace.slice(0, -1)
74
- : segmentsWithoutNamespace;
75
- // Nest the parsed content based on the path segments
76
- const nestedMessages = nestObjectFromPath(keyPath, raw);
77
- parsedFileEntries.push({ namespace, messages: nestedMessages });
78
- }
79
- catch (error) {
80
- logger.warn("Failed to read or parse file.", {
81
- path: fullPath,
82
- error,
83
- });
84
- }
85
- }));
86
- await Promise.all(tasks);
87
- // ---------------------------------------------------------------------------
88
- // Merge parsed entries by namespace
89
- // ---------------------------------------------------------------------------
90
- const result = {};
91
- for (const { namespace, messages } of parsedFileEntries) {
92
- // Root-level namespace (e.g. [locale]/index.json)
93
- if (namespace === "index") {
94
- Object.assign(result, deepMerge(result, messages));
95
- }
96
- else {
97
- result[namespace] = deepMerge(result[namespace], messages);
98
- }
99
- }
100
- return result;
101
- }
102
-
103
- export { parseFileEntries };
@@ -1,12 +0,0 @@
1
- import fs from 'node:fs/promises';
2
-
3
- /**
4
- * Read & parse a JSON file
5
- */
6
- async function jsonReader(filePath, readFile = fs.readFile) {
7
- const raw = await readFile(filePath, "utf8");
8
- const parsed = JSON.parse(raw);
9
- return parsed;
10
- }
11
-
12
- export { jsonReader };
@@ -1,42 +0,0 @@
1
- import path from 'node:path';
2
- import { collectFileEntries } from './collect-file-entries/collect-file-entries.js';
3
- import { parseFileEntries } from './parse-file-entries/parse-file-entries.js';
4
-
5
- /**
6
- * Read and assemble messages for a single locale from the file system.
7
- *
8
- * This function acts as a thin orchestration layer:
9
- * - Collects message file metadata for the locale
10
- * - Parses files into a single Messages object
11
- * - Wraps the result under the locale key
12
- *
13
- * It does not perform validation or transformation itself.
14
- */
15
- const readLocaleMessages = async ({ locale, namespaces, rootDir = "messages", limit, readers, loggerOptions, }) => {
16
- // ---------------------------------------------------------------------------
17
- // Collect message file entries for the locale
18
- // ---------------------------------------------------------------------------
19
- const fileEntries = await collectFileEntries({
20
- namespaces,
21
- rootDir: path.resolve(rootDir, locale),
22
- limit,
23
- exts: Object.keys(readers || {}),
24
- loggerOptions,
25
- });
26
- // ---------------------------------------------------------------------------
27
- // Parse collected files into a Messages object (single-locale)
28
- // ---------------------------------------------------------------------------
29
- const messages = await parseFileEntries({
30
- fileEntries,
31
- limit,
32
- readers,
33
- loggerOptions,
34
- });
35
- // ---------------------------------------------------------------------------
36
- // Wrap parsed messages under the locale key
37
- // ---------------------------------------------------------------------------
38
- const localeMessages = { [locale]: messages };
39
- return localeMessages;
40
- };
41
-
42
- export { readLocaleMessages };
@@ -1,78 +0,0 @@
1
- import '../../core/error/intor-error.js';
2
- import { resolveLoaderOptions } from '../../core/utils/resolve-loader-options.js';
3
- import { getLogger } from '../../core/logger/get-logger.js';
4
- import { loadRemoteMessages } from '../../core/messages/load-remote-messages/load-remote-messages.js';
5
- import 'intor-translator';
6
- import { loadLocalMessages } from './load-local-messages/load-local-messages.js';
7
-
8
- /**
9
- * Load locale messages according to the resolved Intor loader configuration.
10
- *
11
- * This function is the top-level orchestration entry for message loading.
12
- * It is responsible for:
13
- *
14
- * - Resolving the active loader strategy (local or remote)
15
- * - Dispatching to the appropriate loader implementation
16
- * - Passing through cache and read-related options
17
- *
18
- * Message traversal, parsing, fallback resolution, and caching logic
19
- * are delegated to the selected loader.
20
- */
21
- const loadMessages = async ({ config, locale, readers, allowCacheWrite = false, fetch, }) => {
22
- const baseLogger = getLogger(config.logger);
23
- const logger = baseLogger.child({ scope: "load-messages" });
24
- // ---------------------------------------------------------------------------
25
- // Resolve loader configuration
26
- // ---------------------------------------------------------------------------
27
- const loader = resolveLoaderOptions(config, "server");
28
- if (!loader) {
29
- logger.warn("No loader options have been configured in the current config.");
30
- return;
31
- }
32
- const { mode, namespaces, concurrency } = loader;
33
- const fallbackLocales = config.fallbackLocales[locale] || [];
34
- logger.info(`Loading messages for locale "${locale}".`);
35
- logger.trace("Starting to load messages with runtime context.", {
36
- loaderMode: mode,
37
- ...(mode === "local" ? { rootDir: loader.rootDir } : {}),
38
- locale,
39
- fallbackLocales: fallbackLocales.join(", "),
40
- namespaces: namespaces && namespaces.length > 0 ? [...namespaces] : "*",
41
- });
42
- // ---------------------------------------------------------------------------
43
- // Dispatch to loader implementation
44
- // ---------------------------------------------------------------------------
45
- let loadedMessages;
46
- if (mode === "local") {
47
- loadedMessages = await loadLocalMessages({
48
- id: config.id,
49
- locale,
50
- fallbackLocales,
51
- namespaces,
52
- rootDir: loader.rootDir,
53
- concurrency,
54
- readers,
55
- allowCacheWrite,
56
- loggerOptions: config.logger,
57
- });
58
- }
59
- else if (mode === "remote") {
60
- loadedMessages = await loadRemoteMessages({
61
- locale,
62
- fallbackLocales,
63
- namespaces,
64
- concurrency,
65
- fetch,
66
- url: loader.url,
67
- headers: loader.headers,
68
- loggerOptions: config.logger,
69
- });
70
- }
71
- // Final sanity check
72
- if (!loadedMessages || Object.keys(loadedMessages).length === 0) {
73
- logger.warn("No messages found.", { locale, fallbackLocales, namespaces });
74
- }
75
- return loadedMessages;
76
- };
77
-
78
- export { loadMessages };
@@ -1,36 +0,0 @@
1
- import '../../core/error/intor-error.js';
2
- import { resolveLoaderOptions } from '../../core/utils/resolve-loader-options.js';
3
- import 'logry';
4
- import 'p-limit';
5
- import { createTranslator } from '../../core/translator/create-translator.js';
6
- import 'intor-translator';
7
- import { loadMessages } from '../messages/load-messages.js';
8
- import 'node:path';
9
- import 'node:fs/promises';
10
-
11
- /**
12
- * Initialize a locale-bound Translator snapshot.
13
- *
14
- * - Resolves loader options and loads messages if configured
15
- * - Creates an immutable Translator instance for server usage
16
- */
17
- async function initTranslator(config, locale, options) {
18
- const { readers, allowCacheWrite = false, fetch, handlers, plugins, } = options;
19
- const loader = resolveLoaderOptions(config, "server");
20
- // Load messages
21
- let messages = {};
22
- if (loader) {
23
- const loaded = await loadMessages({
24
- config,
25
- locale,
26
- readers,
27
- allowCacheWrite,
28
- fetch,
29
- });
30
- messages = loaded || {};
31
- }
32
- // Create immutable translator snapshot
33
- return createTranslator({ config, locale, messages, handlers, plugins });
34
- }
35
-
36
- export { initTranslator };
@@ -1 +0,0 @@
1
- export { createIntorHandler, intor } from "../../../src/adapters/svelte-kit/server";
@@ -1,2 +0,0 @@
1
- export { createIntorHandler } from "./create-intor-handler";
2
- export { intor } from "./intor";
@@ -1,20 +0,0 @@
1
- import type { IntorResolvedConfig } from "../../../config";
2
- import type { MessagesReaders, RuntimeFetch } from "../../../core";
3
- import type { Locale, LocaleMessages } from "intor-translator";
4
- import { type IntorValue as IntorValueCore } from "../../../server";
5
- interface IntorValue extends Pick<IntorValueCore, "config"> {
6
- locale: Locale;
7
- messages: Readonly<LocaleMessages>;
8
- }
9
- /**
10
- * Initializes Intor for the current execution context.
11
- *
12
- * - Uses the locale resolved by the SvelteKit request lifecycle.
13
- * - Permits cache writes during server execution.
14
- * @platform SvelteKit
15
- */
16
- export declare function intor(config: IntorResolvedConfig, locale: Locale, fetch: RuntimeFetch, options?: {
17
- readers?: MessagesReaders;
18
- allowCacheWrite?: boolean;
19
- }): Promise<IntorValue>;
20
- export {};