@wxn0brp/falcon-frame-lang 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 wxn0brP
+
+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

@@ -0,0 +1,100 @@
+# @wxn0brp/falcon-frame-lang
+
+A localization middleware for the FalconFrame framework that enables multi-language support for web applications.
+
+## Overview
+
+This package provides easy-to-use internationalization (i18n) functionality for FalconFrame applications. It allows developers to create multi-language websites by automatically translating content based on user preferences and language files.
+
+## Features
+
+- **Automatic Language Detection**: Detects user"s language preference from cookies or the `Accept-Language` header
+- **HTML Translation**: Translates HTML content by finding and replacing translation keys
+- **Flexible Configuration**: Customizable directory paths and translation patterns
+- **Caching**: Includes caching mechanism to improve performance
+- **Attribute-based Translations**: Supports translation via HTML attributes as well as content
+
+## Installation
+
+```bash
+yarn add github:wxn0brP/FalconFrame-lang#dist
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { createLangRouter } from "@wxn0brp/falcon-frame-lang";
+
+const config = {
+    meta: {
+        "home": { title: "Home Page" },
+        "about": { title: "About Us" }
+    },
+    dir: "public",                // Directory containing HTML files (default: "public")
+    layout: "public/layout.html", // Layout file path (default: "public/layout.html")
+    langDir: "public/lang",       // Directory containing language JSON files (default: "public/lang")
+    getSpecific: (name: string) => {
+        // Return specific data for the given page name
+        return {};
+    }
+};
+
+const langRouter = createLangRouter(config);
+```
+
+### Language Files
+
+Create language files in the `langDir` (by default `public/lang/`) with the format `{langCode}.json`:
+
+```json
+{
+    "about us": "About Us",
+    "contact": "Contact",
+    "image_alt_text": "Image Alt Text",
+    "welcome": "Welcome to our website"
+}
+```
+
+### Translating HTML
+
+The middleware translates HTML in three ways:
+
+1. **Content-based translation**: Text content inside HTML tags
+   ```html
+   <h1 translate="about us"></h1>  <!-- Will be translated to "About Us" -->
+   ```
+
+2. **Attribute-based translation**: Using `translate-*` attributes
+   ```html
+   <input type="text" translate-placeholder="contact us" /> <!-- Will add translated placeholder attribute -->
+   <img src="image.jpg" translate-alt="image_alt_text">  <!-- Will translate the alt attribute -->
+   ```
+
+3. **Translate attribute**: Using the `translate` attribute for direct element translation
+   ```html
+   <h1 translate="welcome"></h1>  <!-- Will translate the content to "Welcome to our website" -->
+   <button translate="contact"></button>  <!-- Will translate the content to "Contact" -->
+   ```
+
+### Language Detection
+
+The package detects the user"s preferred language in the following order:
+1. `lang` query parameter
+2. `lang` cookie value
+3. `Accept-Language` header from the request
+4. Defaults to "en" if no language is detected
+
+## Dependencies
+
+- `@wxn0brp/ac`: For caching functionality
+- `@wxn0brp/falcon-frame`: The main FalconFrame framework
+
+## Performance & Caching
+
+The middleware uses an efficient caching mechanism to improve performance. Language files are loaded once and cached in memory to prevent repeated file system operations. This results in faster response times for subsequent requests requiring the same language translations.
+
+## License
+
+MIT License.

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "@wxn0brp/falcon-frame-lang",
+    "version": "0.0.2",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "description": "FalconFrame language middleware for multi-language support",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/wxn0brP/FalconFrame-lang.git"
+    },
+    "homepage": "https://github.com/wxn0brP/FalconFrame",
+    "author": "wxn0brP",
+    "license": "MIT",
+    "type": "module",
+    "scripts": {
+        "build": "tsc && tsc-alias"
+    },
+    "keywords": [
+        "falcon-frame",
+        "i18n",
+        "localization",
+        "translation",
+        "lang",
+        "language"
+    ],
+    "devDependencies": {
+        "@types/node": "*",
+        "@wxn0brp/ac": "^0.0.2",
+        "@wxn0brp/falcon-frame": "^0.4.0",
+        "typescript": "*"
+    },
+    "peerDependencies": {
+        "@wxn0brp/ac": ">=0.0.2",
+        "@wxn0brp/falcon-frame": ">=0.4.0"
+    },
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        },
+        "./*": {
+            "types": "./dist/*.d.ts",
+            "import": "./dist/*.js",
+            "default": "./dist/*.js"
+        }
+    }
+}