canopy-i18n 0.5.0 → 0.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Masaaki Ota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,9 @@
 
 A tiny, type-safe i18n library for building localized messages with builder pattern and applying locales across nested data structures.
 
+![スクリーンショット](https://raw.githubusercontent.com/mohhh-ok/canopy-i18n/main/docs/images/hero.gif)
+
+
 ## Features
 - **AI-friendly**: Full type safety and single-file colocation give AI assistants complete context for accurate code generation.
 - **Type-safe**: Compile-time safety for locale keys with full TypeScript IntelliSense support.
@@ -144,11 +147,12 @@ const builder = createI18n(['ja', 'en', 'fr'] as const);
 ### `ChainBuilder`
 A builder class for creating multiple localized messages with method chaining.
 
-#### `.add<ReturnType = string>(entries)`
+#### `.add<ReturnType = string, K extends string = string>(entries)`
 Adds multiple messages at once. By default, returns `string`, but you can specify a custom return type.
 
 - **ReturnType**: (optional) Type parameter for the return value (defaults to `string`)
-- **entries**: `Record<string, Record<Locale, ReturnType>>`
+- **K**: (optional) Type parameter for the keys of the entries record (defaults to `string`)
+- **entries**: `Record<K, Record<Locale, ReturnType>>`
 - Returns: `ChainBuilder` with added messages
 
 ```ts
@@ -184,14 +188,15 @@ const menu = createI18n(['ja', 'en'] as const)
   });
 ```
 
-#### `.addTemplates<Context, ReturnType = string>()(entries)`
+#### `.addTemplates<Context, ReturnType = string, K extends string = string>()(entries)`
 Adds multiple template function messages at once with a unified context type and custom return type.
 
-Note: This uses a curried API for better type inference. Call `addTemplates<Context, ReturnType>()` first, then call the returned function with entries.
+Note: This uses a curried API for better type inference. Call `addTemplates<Context, ReturnType, K>()` first, then call the returned function with entries.
 
 - **Context**: Type parameter for the template function context
 - **ReturnType**: (optional) Type parameter for the return value (defaults to `string`)
-- **entries**: `Record<string, Record<Locale, (ctx: Context) => ReturnType>>`
+- **K**: (optional) Type parameter for the keys of the entries record (defaults to `string`)
+- **entries**: `Record<K, Record<Locale, (ctx: Context) => ReturnType>>`
 - Returns: `ChainBuilder` with added template messages
 
 ```ts

package/dist/chainBuilder.d.ts

@@ -8,18 +8,18 @@ export declare class ChainBuilder<const Ls extends readonly string[], Messages e
      * 複数のメッセージを一度に追加
      * 型パラメータRでカスタム型も指定可能(デフォルトはstring)
      */
-    add<R = string, Entries extends Record<string, Record<Ls[number], R>> = Record<string, Record<Ls[number], R>>>(entries: {
-        [K in keyof Entries]: K extends keyof Messages ? never : Entries[K];
+    add<R = string, K extends string = string, Entries extends Record<K, Record<Ls[number], R>> = Record<K, Record<Ls[number], R>>>(entries: {
+        [Key in keyof Entries]: Key extends keyof Messages ? never : Entries[Key];
     }): ChainBuilder<Ls, Messages & {
-        [K in keyof Entries]: I18nMessage<Ls, void, R>;
+        [Key in keyof Entries]: I18nMessage<Ls, void, R>;
     }>;
     /**
      * 関数指定版: 複数のテンプレート関数を一度に追加(型は統一)
      */
-    addTemplates<C, R = string>(): <Entries extends Record<string, Record<Ls[number], (ctx: C) => R>>>(entries: {
-        [K in keyof Entries]: K extends keyof Messages ? never : Entries[K];
+    addTemplates<C, R = string, K extends string = string>(): <Entries extends Record<K, Record<Ls[number], (ctx: C) => R>>>(entries: {
+        [Key in keyof Entries]: Key extends keyof Messages ? never : Entries[Key];
     }) => ChainBuilder<Ls, Messages & {
-        [K in keyof Entries]: I18nMessage<Ls, C, R>;
+        [Key in keyof Entries]: I18nMessage<Ls, C, R>;
     }>;
     private deepCloneWithLocale;
     build<M = {

package/dist/testtest.js

@@ -7,6 +7,14 @@ const b = a
 });
 const c = b.build("en");
 const e = { ...c.abc, toString: () => "aaa" };
+const d = b.add({
+    aaa: { ja: "aaa", en: "aaa" },
+    bbb: { ja: "bbb", en: "bbb" },
+});
+const f = b.addTemplates()({
+    aaa: { ja: ({ a }) => `${a}aaa`, en: ({ a }) => `${a}aaa` },
+    bbb: { ja: ({ a }) => `${a}aaa`, en: ({ a }) => `${a}aaa` },
+});
 console.log(c.bb({ aa: "name" }));
 console.log(`${c.bb({ aa: "name" })}`);
 console.log("aaa" + c.bb({ aa: "name" }));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "canopy-i18n",
-  "version": "0.5.0",
-  "description": "A tiny, type-safe i18n helper",
+  "version": "0.6.0",
+  "description": "The Type-Safe i18n library that your IDE will Love",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,14 +25,15 @@
     "prepublishOnly": "pnpm run build",
     "type-check": "tsc -p . --noEmit",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "release": "release-it"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.8",
-    "@types/node": "^24.10.4",
-    "release-it": "^19.2.2",
+    "@types/node": "^25.0.10",
+    "release-it": "^19.2.4",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.16"
+    "vitest": "^4.0.18"
   },
   "keywords": [
     "i18n",
@@ -48,6 +49,6 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/MOhhh-ok/canopy-i18n"
+    "url": "https://github.com/mohhh-ok/canopy-i18n"
   }
 }