@uipkge/nuxt 0.1.1 → 10.2.3-i18now.1

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) Nuxt Community
+Copyright (c) Rafał Chłodnicki (@rchl)
+Copyright (c) Paul Gascou-Vaillancourt (@paulgv)
+Copyright (c) Kazuya Kawaguchi (@kazupon)
+Copyright (c) Bobbie Goede (@BobbieGoede)
+
+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

@@ -1,130 +1,48 @@
 # @uipkge/nuxt
 
-Nuxt module for [i18now](https://i18now.com) — loads translations from the i18now CDN and automatically syncs new keys to your project during development.
+A fork of [@nuxtjs/i18n](https://github.com/nuxt-modules/i18n) with built-in [i18now](https://i18now.com) key sync.
 
-## Features
+## What's different
 
-- Loads published translations from the i18now CDN at SSR time
-- Reloads translations on locale switch (client-side)
-- In development: detects missing translation keys and syncs them to i18now automatically
-- Suppresses vue-i18n missing-key warnings in dev — missing keys are expected until published
-- API key is never exposed to the browser (proxied through a local Nuxt server route)
-- Zero bundle impact in production — dev-only code is tree-shaken at build time
+This package is identical to `@nuxtjs/i18n` with one addition: when `i18now` is configured, missing translation keys detected in development are automatically synced to your i18now project.
 
-## Installation
+## Install
 
-```bash
-npm install @uipkge/nuxt
-# or
+```sh
 pnpm add @uipkge/nuxt
 ```
 
-`@nuxtjs/i18n` is a dependency and will be installed automatically.
+## Usage
 
-## Setup
-
-Add the module to `nuxt.config.ts`:
+Replace `@nuxtjs/i18n` with `@uipkge/nuxt` in your `nuxt.config.ts`. All existing configuration works the same — follow the [@nuxtjs/i18n documentation](https://i18n.nuxtjs.org/) for setup, locales, routing, and all other options.
 
 ```ts
+// nuxt.config.ts
 export default defineNuxtConfig({
   modules: ['@uipkge/nuxt'],
-
-  i18now: {
-    projectId: process.env.I18NOW_PROJECT_ID ?? '',
-    apiKey: process.env.I18NOW_API_KEY ?? '',
-  },
-
   i18n: {
     defaultLocale: 'en',
-    locales: ['en', 'es', 'fr'],
-    bundle: {
-      optimizeTranslationDirective: false, // buggy, deprecated in v10
+    locales: [
+      { code: 'en', file: 'en.json' },
+      { code: 'fr', file: 'fr.json' },
+    ],
+    langDir: 'i18n/locales/',
+
+    // i18now sync — add this block to enable automatic key collection in dev
+    i18now: {
+      projectId: process.env.I18NOW_PROJECT_ID,
+      apiKey: process.env.I18NOW_API_KEY,
     },
   },
 })
 ```
 
-## Configuration
+When `i18now` is configured, any `$t('key', 'Default text')` call where the key is missing from your locale files will be automatically collected and sent to i18now during development. The `apiKey` is kept server-side and never exposed to the browser.
 
-| Option        | Type       | Default                    | Description                                                                 |
-|---------------|------------|----------------------------|-----------------------------------------------------------------------------|
-| `projectId`   | `string`   | —                          | **Required.** Your i18now project ID.                                       |
-| `apiKey`      | `string`   | —                          | **Required.** Your i18now API key. Never sent to the browser.               |
-| `host`        | `string`   | `https://i18now.com`       | i18now server URL. Set to `http://localhost:3220` for local development.    |
-| `cdnUrl`      | `string`   | `https://cdn.i18now.com`   | CDN base URL where published translations are served.                       |
-| `environment` | `string`   | `'dev'`                    | Which published environment to load translations from (`dev`, `stage`, `prod`). |
-| `syncIn`      | `string[]` | `['development']`          | Node environments where missing-key sync is active. Keep as `['development']`. |
-| `locale`      | `string`   | `'en'`                     | Fallback locale used before `@nuxtjs/i18n` initialises.                     |
-
-### Environment variables
-
-Store secrets in `.env`:
-
-```env
-I18NOW_PROJECT_ID=your-project-id
-I18NOW_API_KEY=your-api-key
-```
-
-## How it works
-
-### Production
-
-The server plugin fetches the published translation JSON from the CDN (`{cdnUrl}/{projectId}/publish/{environment}/{locale}.json`) during SSR and injects it into vue-i18n. Translations are refreshed on locale switch.
-
-### Development
-
-The client plugin intercepts every `$t()` and `useI18n().t()` call. When a key is missing from the CDN snapshot it batches that key (with its default value) and POSTs it to a local Nuxt server route (`/api/_i18now/sync`). The server route adds the API key and forwards the request to i18now — so your API key never appears in browser network requests.
-
-```
-Browser $t('key', 'Default text')
-  → client plugin detects missing key
-  → POST /api/_i18now/sync  { keys: [{ key, value }] }
-  → Nuxt server adds apiKey
-  → POST i18now /api/v1/projects/:id/sync
-```
+## Documentation
 
-The `useI18n` composable is auto-imported by the module and silently overrides the one from `@nuxtjs/i18n` — no changes to existing component code are required.
+For all i18n configuration options, refer to the official [@nuxtjs/i18n docs](https://i18n.nuxtjs.org/).
 
-Vue-i18n's missing-key and fallback warnings are suppressed automatically in dev. Keys are expected to be absent until they are published from the i18now dashboard, at which point they load from CDN and no longer trigger warnings.
+## License
 
-## Security
-
-- `apiKey` is stored in Nuxt's private (server-only) `runtimeConfig` — it is never serialised into the client bundle or sent in any browser request.
-- The `syncIn` option defaults to `['development']`. **Never add `'production'` or `'staging'`** — doing so would expose your API key to end users and flood your project with traffic.
-
-## Local development against a local i18now server
-
-```ts
-// nuxt.config.ts
-i18now: {
-  projectId: 'your-project-id',
-  apiKey: 'your-api-key',
-  host: 'http://localhost:3220',
-  cdnUrl: 'http://localhost:3220', // if serving snapshots locally
-  environment: 'dev',
-},
-```
-
-## Playground
-
-A minimal playground is included in `playground/`. To run it:
-
-```bash
-pnpm dev:playground
-```
-
-## Building locally
-
-```bash
-pnpm build
-```
-
-To use the built package in another local project, add a `file:` reference:
-
-```json
-{
-  "dependencies": {
-    "@uipkge/nuxt": "file:../path/to/i18now/packages/nuxt"
-  }
-}
-```
+[MIT](./LICENSE) — based on @nuxtjs/i18n, Copyright (c) Nuxt Community