intor 2.3.0 → 2.3.2

package/README.md

@@ -1,22 +1,23 @@
-# Intor
+<h1 align="center">Intor</h1>
 
-A modular and extensible i18n core for JavaScript/TypeScript.
+<div align="center">
+  
+A lightweight, framework-agnostic i18n engine that works instantly with a clean, type-safe API.  
+Fast to start, easy to extend, and free from the usual i18n heaviness.
 
-## Features
+</div>
 
-- ✅ Runtime configuration
-- ✅ Backend and frontend support
-- ✅ Custom messages and adapters
-- ✅ Caching, error handling, and logging
+<div align="center">
 
-## Installation
+[![NPM version](https://img.shields.io/npm/v/intor?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/intor)
+[![Bundle size](https://img.shields.io/bundlephobia/minzip/intor?style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/package/intor)
+[![TypeScript](https://img.shields.io/badge/TypeScript-%E2%9C%94-blue?style=flat&colorA=000000&colorB=000000)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/npm/l/intor?style=flat&colorA=000000&colorB=000000)](LICENSE)
 
-```bash
-npm install intor
-```
+</div>
 
-Or use **yarn**
+<div align="center">
 
-```bash
-yarn add intor
-```
+#### 🍳 Cooking the Intor v2 docs, crafting them to perfection...
+
+</div>

package/dist/exports/index.d.ts

@@ -2,4 +2,4 @@
 export { PREFIX_PLACEHOLDER } from "../src/shared/constants/prefix-placeholder";
 export { mergeMessages, normalizeCacheKey, resolveNamespaces, normalizeLocale, resolvePreferredLocale, extractPathname, normalizePathname, standardizePathname, } from "../src/shared/utils";
 export { IntorError, IntorErrorCode } from "../src/shared/error";
-export { Translator, type TranslateHandlers, type FormatHandler, type LoadingHandler, type MissingHandler, type TranslateHandlerContext, type Locale, type FallbackLocalesMap, type NestedMessage, type LocaleMessages, type LocalizedMessagesUnion, type Replacement, type NodeKeys, type LeafKeys, type LocalizedLeafKeys, type ScopedLeafKeys, } from "intor-translator";
+export { Translator, type TranslatorOptions, type TranslatorMethods, type TranslatorPlugin, type TranslateConfig, type TranslateHandlers, type FormatHandler, type LoadingHandler, type MissingHandler, type HandlerContext, type TranslateContext, type TranslateHook, type Locale, type FallbackLocalesMap, type NestedMessage, type LocaleMessages, type LocalizedMessagesUnion, type Replacement, type DefaultDepth, type NodeKeys, type LeafKeys, type LocalizedNodeKeys, type LocalizedLeafKeys, type ScopedLeafKeys, } from "intor-translator";

package/dist/src/client/react/contexts/translator/hook.d.ts

@@ -1,2 +1,3 @@
 import type { TranslatorContextValue } from "./types";
-export declare function useTranslator<M>(): TranslatorContextValue<M>;
+import type { LocaleMessages } from "intor-translator";
+export declare function useTranslator<M extends LocaleMessages = LocaleMessages>(): TranslatorContextValue<M>;

package/dist/src/client/react/contexts/translator/types.d.ts

@@ -1,6 +1,6 @@
-import type { Translator } from "intor-translator";
+import type { LocaleMessages, Translator } from "intor-translator";
 import type * as React from "react";
-export type TranslatorContextValue<M = unknown> = {
+export type TranslatorContextValue<M extends LocaleMessages = LocaleMessages> = {
     translator: Translator<M>;
 };
 export type TranslatorProviderProps = {

package/dist/src/shared/types/translator-instance.types.d.ts

@@ -1,5 +1,5 @@
 import type { IfGen } from "../../shared/types/generated.types";
-import { type Locale, type Replacement, type ScopedLeafKeys, type LocalizedLeafKeys } from "intor-translator";
+import { type Locale, type Replacement, type ScopedLeafKeys, type LocalizedLeafKeys, type LocaleMessages } from "intor-translator";
 /** Base properties shared by all translator instances. */
 export interface TranslatorBaseProps<M = unknown> {
     /** `messages`: The message object containing all translations. */
@@ -19,12 +19,12 @@ export interface TranslatorClientProps<M = unknown> {
  * - Resolves to `ScopedLeafKeys` if a pre-key `PK` is provided,
  * otherwise resolves to `LocalizedLeafKeys`.
  */
-type Key<M, PK> = IfGen<PK extends string ? ScopedLeafKeys<M, PK> : LocalizedLeafKeys<M>, string>;
+type Key<M extends LocaleMessages, PK> = IfGen<PK extends string ? ScopedLeafKeys<M, PK> : LocalizedLeafKeys<M>, string>;
 /**
  * Translator instance type.
  * Combines base props, client props, and core translation methods.
  */
-export type TranslatorInstance<M, PK extends string | undefined = undefined> = {
+export type TranslatorInstance<M extends LocaleMessages, PK extends string | undefined = undefined> = {
     /** Check if a given key exists in the messages. */
     hasKey: (key?: Key<M, PK>, targetLocale?: Locale<M>) => boolean;
     /** Translate a given key into its string representation. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intor",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "A modular and extensible i18n core designed for TypeScript and JavaScript projects. Intor enables custom translation logic with support for both frontend and backend environments, featuring runtime configuration, caching, adapters, and message loaders.",
   "author": "Yiming Liao",
   "license": "MIT",
@@ -63,6 +63,8 @@
     "README.md",
     "LICENSE"
   ],
+  "main": "./dist/exports/index.js",
+  "module": "./dist/exports/index.js",
   "type": "module",
   "scripts": {
     "type": "tsc --noEmit",
@@ -76,10 +78,11 @@
     "build:next": "rollup -c .config/rollup/next.js",
     "build:dts": "rollup -c .config/rollup/dts.js",
     "build": "yarn clean && yarn build:core && yarn build:react && yarn build:next &&  yarn tsc -p tsconfig.build.json && yarn tsc-alias tsconfig.build.json --outDir dist",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "examples:html": "vite --config examples/html/vite.config.ts"
   },
   "dependencies": {
-    "intor-translator": "^1.1.5",
+    "intor-translator": "^1.2.0",
     "keyv": "^5.5.3",
     "lodash.merge": "^4.6.2",
     "logry": "^2.0.1",
@@ -113,6 +116,7 @@
     "tsc-alias": "^1.8.16",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.32.1",
+    "vite": "^7.2.6",
     "vitest": "^4.0.9"
   },
   "sideEffects": false,