@i18n-micro/types 1.0.15

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+ 
+ Copyright (c) 2016 
+ 
+ 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,126 @@
+# @i18n-micro/types
+
+`@i18n-micro/types` provides TypeScript type definitions and interfaces for the `nuxt-i18n-micro` ecosystem. This package is designed to enhance type safety and developer experience when working with translations, locales, and routing in a Nuxt.js application. It includes types for locales, routing strategies, translation parameters, and more.
+
+## Installation
+
+You can install `@i18n-micro/types` using npm or yarn:
+
+```bash
+npm install @i18n-micro/types
+```
+
+or
+
+```bash
+yarn add @i18n-micro/types
+```
+
+## Usage
+
+This package provides TypeScript types and interfaces for working with `nuxt-i18n-micro`. It is primarily used to ensure type safety when defining locales, routing strategies, and translation parameters.
+
+### Example
+
+Here’s an example of how you might use the types provided by this package:
+
+```typescript
+import { Locale, Strategies, ModuleOptions, I18nRouteParams } from '@i18n-micro/types'
+
+// Define locales
+const locales: Locale[] = [
+  {
+    code: 'en',
+    iso: 'en-US',
+    dir: 'ltr',
+    displayName: 'English',
+    baseUrl: 'https://example.com/en',
+  },
+  {
+    code: 'de',
+    iso: 'de-DE',
+    dir: 'ltr',
+    displayName: 'German',
+    baseUrl: 'https://example.com/de',
+  },
+]
+
+// Define routing strategy
+const strategy: Strategies = 'prefix_except_default'
+
+// Define module options
+const options: ModuleOptions = {
+  locales,
+  strategy,
+  defaultLocale: 'en',
+  includeDefaultLocaleRoute: true,
+}
+
+// Define route parameters
+const routeParams: I18nRouteParams = {
+  en: { page: 'home' },
+  de: { page: 'startseite' },
+}
+```
+
+## API Reference
+
+### Types and Interfaces
+
+#### `Locale`
+Represents a locale configuration.
+
+#### `LocaleCode`
+Represents a locale code (e.g., `'en'`, `'de'`).
+
+#### `Strategies`
+Represents the available routing strategies.
+
+```typescript
+export type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default'
+```
+
+#### `ModuleOptions`
+Represents the configuration options for the `nuxt-i18n-micro` module.
+
+#### `ModuleOptionsExtend`
+Extends `ModuleOptions` with additional properties.
+
+#### `I18nRouteParams`
+Represents route parameters for different locales.
+
+#### `Params`
+Represents a key-value pair of parameters for interpolation.
+
+#### `PluralFunc`
+Represents a function for handling pluralization in translations.
+
+#### `GlobalLocaleRoutes`
+Represents global route configurations for different locales.
+
+#### `Translations`
+Represents a key-value pair of translations.
+
+#### `Translation`
+Represents a translation value, which can be a string, number, boolean, nested translations, or `null`.
+
+#### `PluralTranslations`
+Represents translations for singular and plural forms.
+
+## Contributing
+
+If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/s00d/nuxt-i18n-micro).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/s00d/nuxt-i18n-micro/blob/main/LICENSE) file for more details.
+
+---
+
+For more information, visit the [GitHub repository](https://github.com/s00d/nuxt-i18n-micro).
+
+## Author
+
+- **Name**: s00d
+- **Email**: Virus191288@gmail.com
+- **Website**: [https://s00d.github.io/](https://s00d.github.io/)

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=()=>{};exports.init=t;

package/dist/index.d.ts

@@ -0,0 +1,113 @@
+export type LocaleCode = string;
+export interface DefineLocaleMessage {
+    readonly __augmentation?: never;
+}
+export type TranslationKey = keyof DefineLocaleMessage extends never ? string : keyof DefineLocaleMessage | string;
+/**
+ * Хелпер для создания типизированных префиксов.
+ * Позволяет безопасно использовать динамические ключи.
+ *
+ * @example
+ * ```typescript
+ * // Допустим, есть ключи: 'errors.404', 'errors.500', 'btn.save'
+ * function getErrorText(code: string) {
+ *   return t(`errors.${code}` as ScopedKey<'errors'>)
+ * }
+ * ```
+ */
+export type ScopedKey<Scope extends string> = Extract<TranslationKey, `${Scope}.${string}`>;
+export interface Locale {
+    code: LocaleCode;
+    disabled?: boolean;
+    iso?: string;
+    dir?: 'ltr' | 'rtl' | 'auto';
+    displayName?: string;
+    baseUrl?: string;
+    baseDefault?: boolean;
+    fallbackLocale?: string;
+    [key: string]: unknown;
+}
+export interface DefineI18nRouteConfig {
+    locales?: string[] | Record<LocaleCode, Translations>;
+    localeRoutes?: Record<LocaleCode, string>;
+    disableMeta?: boolean | string[];
+}
+export type I18nRouteParams = Record<LocaleCode, Record<string, string>> | null;
+export type Params = Record<string, string | number | boolean>;
+export type Getter = (key: TranslationKey, params?: Record<string, string | number | boolean>, defaultValue?: string) => unknown;
+export type PluralFunc = (key: TranslationKey, count: number, params: Params, locale: string, getter: Getter) => string | null;
+export type GlobalLocaleRoutes = Record<string, Record<LocaleCode, string> | false | boolean> | null | undefined;
+export type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default';
+export type MissingHandler = (locale: string, key: TranslationKey, routeName: string, instance?: unknown, type?: string) => void;
+export interface ModuleOptions {
+    locales?: Locale[];
+    meta?: boolean;
+    strategy?: Strategies;
+    metaBaseUrl?: string;
+    define?: boolean;
+    redirects?: boolean;
+    plugin?: boolean;
+    hooks?: boolean;
+    defaultLocale?: string;
+    apiBaseUrl?: string;
+    apiBaseClientHost?: string;
+    apiBaseServerHost?: string;
+    translationDir?: string;
+    autoDetectLanguage?: boolean;
+    autoDetectPath?: string;
+    disableWatcher?: boolean;
+    types?: boolean;
+    includeDefaultLocaleRoute?: boolean;
+    routesLocaleLinks?: {
+        [key: string]: string;
+    };
+    plural?: string | PluralFunc;
+    disablePageLocales?: boolean;
+    fallbackLocale?: string;
+    localeCookie?: string;
+    debug?: boolean;
+    globalLocaleRoutes?: GlobalLocaleRoutes;
+    customRegexMatcher?: string | RegExp;
+    noPrefixRedirect?: boolean;
+    canonicalQueryWhitelist?: string[];
+    excludePatterns?: (string | RegExp)[];
+    routeLocales?: Record<string, string[]>;
+    routeDisableMeta?: Record<string, boolean | string[]>;
+    missingWarn?: boolean;
+    experimental?: {
+        i18nPreviousPageFallback?: boolean;
+        hmr?: boolean;
+    };
+}
+export interface ModuleOptionsExtend extends ModuleOptions {
+    dateBuild: number;
+    hashMode: boolean;
+    isSSG: boolean;
+    apiBaseUrl: string;
+    disablePageLocales: boolean;
+}
+export interface ModulePrivateOptionsExtend extends ModuleOptions {
+    rootDir: string;
+    rootDirs: string[];
+    debug: boolean;
+    translationDir: string;
+    fallbackLocale: string;
+    apiBaseUrl: string;
+    apiBaseClientHost?: string;
+    apiBaseServerHost?: string;
+    customRegexMatcher?: string | RegExp;
+    routesLocaleLinks?: {
+        [key: string]: string;
+    };
+}
+export interface PluralTranslations {
+    singular: string;
+    plural: string;
+}
+export type CleanTranslation = string | number | boolean | Translations | PluralTranslations | null;
+export type Translation = CleanTranslation | unknown;
+export interface Translations {
+    [key: string]: Translation;
+}
+declare const init: () => void;
+export { init };

package/dist/index.mjs

@@ -0,0 +1,5 @@
+const t = () => {
+};
+export {
+  t as init
+};

package/fix.ts

@@ -0,0 +1 @@
+import '@types/jest'

package/jest.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  roots: ['<rootDir>/tests'],
+  testMatch: ['**/?(*.)+(spec|test).[tj]s?(x)'],
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@i18n-micro/types",
+  "version": "1.0.15",
+  "description": "",
+  "repository": "s00d/nuxt-i18n-micro",
+  "license": "MIT",
+  "type": "module",
+  "author": {
+    "name": "s00d",
+    "email": "Virus191288@gmail.com",
+    "url": "https://s00d.github.io/"
+  },
+  "homepage": "https://github.com/s00d/nuxt-i18n-micro",
+  "bugs": {
+    "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "devDependencies": {
+    "vite-plugin-dts": "^4.3.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "echo \"Error: no test specified\""
+  }
+}

package/src/index.ts

@@ -0,0 +1,141 @@
+export type LocaleCode = string
+
+// Реестр ключей. Пользователь (через генератор) будет делать module augmentation этого интерфейса.
+export interface DefineLocaleMessage {
+  // Module augmentation point - will be extended by @i18n-micro/types-generator
+  readonly __augmentation?: never
+}
+
+// Логика определения типа ключа.
+// Если интерфейс пустой (генератор не подключен), тип ключа — string.
+// Если в интерфейсе есть ключи, тип ключа — объединение этих ключей и string (Union Type).
+// Это позволяет использовать как строгие типы (автокомплит), так и обычные строки (динамические ключи).
+export type TranslationKey = keyof DefineLocaleMessage extends never
+  ? string
+  : keyof DefineLocaleMessage | string
+
+/**
+ * Хелпер для создания типизированных префиксов.
+ * Позволяет безопасно использовать динамические ключи.
+ *
+ * @example
+ * ```typescript
+ * // Допустим, есть ключи: 'errors.404', 'errors.500', 'btn.save'
+ * function getErrorText(code: string) {
+ *   return t(`errors.${code}` as ScopedKey<'errors'>)
+ * }
+ * ```
+ */
+export type ScopedKey<Scope extends string> = Extract<TranslationKey, `${Scope}.${string}`>
+
+export interface Locale {
+  code: LocaleCode
+  disabled?: boolean
+  iso?: string
+  dir?: 'ltr' | 'rtl' | 'auto'
+  displayName?: string
+  baseUrl?: string
+  baseDefault?: boolean
+  fallbackLocale?: string
+  [key: string]: unknown
+}
+
+export interface DefineI18nRouteConfig {
+  locales?: string[] | Record<LocaleCode, Translations>
+  localeRoutes?: Record<LocaleCode, string>
+  disableMeta?: boolean | string[]
+}
+export type I18nRouteParams = Record<LocaleCode, Record<string, string>> | null
+
+export type Params = Record<string, string | number | boolean>
+
+export type Getter = (key: TranslationKey, params?: Record<string, string | number | boolean>, defaultValue?: string) => unknown
+export type PluralFunc = (key: TranslationKey, count: number, params: Params, locale: string, getter: Getter) => string | null
+
+export type GlobalLocaleRoutes = Record<string, Record<LocaleCode, string> | false | boolean> | null | undefined
+
+export type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default'
+
+export type MissingHandler = (
+  locale: string,
+  key: TranslationKey,
+  routeName: string,
+  instance?: unknown,
+  type?: string
+) => void
+
+export interface ModuleOptions {
+  locales?: Locale[]
+  meta?: boolean
+  strategy?: Strategies
+  metaBaseUrl?: string
+  define?: boolean
+  redirects?: boolean
+  plugin?: boolean
+  hooks?: boolean
+  defaultLocale?: string
+  apiBaseUrl?: string
+  apiBaseClientHost?: string
+  apiBaseServerHost?: string
+  translationDir?: string
+  autoDetectLanguage?: boolean
+  autoDetectPath?: string
+  disableWatcher?: boolean
+  types?: boolean
+  includeDefaultLocaleRoute?: boolean
+  routesLocaleLinks?: { [key: string]: string }
+  plural?: string | PluralFunc
+  disablePageLocales?: boolean
+  fallbackLocale?: string
+  localeCookie?: string
+  debug?: boolean
+  globalLocaleRoutes?: GlobalLocaleRoutes
+  customRegexMatcher?: string | RegExp
+  noPrefixRedirect?: boolean
+  canonicalQueryWhitelist?: string[]
+  excludePatterns?: (string | RegExp)[]
+  routeLocales?: Record<string, string[]>
+  routeDisableMeta?: Record<string, boolean | string[]>
+  missingWarn?: boolean
+  experimental?: {
+    i18nPreviousPageFallback?: boolean
+    hmr?: boolean
+  }
+}
+
+export interface ModuleOptionsExtend extends ModuleOptions {
+  dateBuild: number
+  hashMode: boolean
+  isSSG: boolean
+  apiBaseUrl: string
+  disablePageLocales: boolean
+}
+
+export interface ModulePrivateOptionsExtend extends ModuleOptions {
+  rootDir: string
+  rootDirs: string[]
+  debug: boolean
+  translationDir: string
+  fallbackLocale: string
+  apiBaseUrl: string
+  apiBaseClientHost?: string
+  apiBaseServerHost?: string
+  customRegexMatcher?: string | RegExp
+  routesLocaleLinks?: { [key: string]: string }
+}
+
+export interface PluralTranslations {
+  singular: string
+  plural: string
+}
+
+export type CleanTranslation = string | number | boolean | Translations | PluralTranslations | null
+export type Translation = CleanTranslation | unknown
+
+export interface Translations {
+  [key: string]: Translation
+}
+
+const init = () => {}
+
+export { init }

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "declaration": true,
+    "declarationDir": "./dist",
+    "sourceMap": true,
+    "rootDir": "./src",
+    "baseUrl": "./",
+    "paths": {
+      "*": ["node_modules/*", "src/types/*"]
+    },
+    "types": ["jest", "node"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "tests"]
+}

package/vite.config.mts

@@ -0,0 +1,25 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+import { resolve } from 'node:path'
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, 'src/index.ts'),
+      name: '@i18n-micro/core',
+      formats: ['cjs', 'es'],
+      fileName: format => `index.${format === 'cjs' ? 'cjs' : 'mjs'}`,
+    },
+    rollupOptions: {
+      external: ['vue'],
+      output: {
+        exports: 'named',
+      },
+    },
+  },
+  plugins: [
+    dts(),
+  ],
+})