@i18n-micro/solid 1.2.0 → 1.2.1

package/dist/index.d.cts

@@ -0,0 +1,305 @@
+import { Accessor } from 'solid-js';
+import { BaseI18n } from '@i18n-micro/core';
+import { CleanTranslation } from '@i18n-micro/types';
+import { Component } from 'solid-js';
+import { Context } from 'solid-js';
+import { defaultPlural } from '@i18n-micro/core';
+import { FormatService } from '@i18n-micro/core';
+import { Getter } from '@i18n-micro/types';
+import { interpolate } from '@i18n-micro/core';
+import { JSX } from 'solid-js';
+import { Locale } from '@i18n-micro/types';
+import { LocaleCode } from '@i18n-micro/types';
+import { Location as Location_2 } from '@solidjs/router';
+import { ModuleOptions } from '@i18n-micro/types';
+import { Params } from '@i18n-micro/types';
+import { ParentComponent } from 'solid-js';
+import { PluralFunc } from '@i18n-micro/types';
+import { TranslationKey } from '@i18n-micro/types';
+import { Translations } from '@i18n-micro/types';
+import { TranslationStorage } from '@i18n-micro/core';
+import { useNavigate } from '@solidjs/router';
+
+export { CleanTranslation }
+
+export declare function createI18n(options: SolidI18nOptions): SolidI18n;
+
+/**
+ * Factory for Solid Router adapter
+ * Implements routing utilities for Solid Router
+ * Uses @solidjs/router APIs for navigation and path resolution
+ *
+ * **IMPORTANT**: This function must be called inside a SolidJS component or reactive context
+ * (e.g., inside a component function, not at module level). This is required because
+ * `createSignal` and `createEffect` need to be within a reactive owner context.
+ *
+ * @example
+ * ```tsx
+ * const RouterRoot: Component = () => {
+ *   const navigate = useNavigate()
+ *   const location = useLocation()
+ *   const routingStrategy = createSolidRouterAdapter(
+ *     locales,
+ *     defaultLocale,
+ *     navigate,
+ *     location,
+ *   )
+ *   // ...
+ * }
+ * ```
+ *
+ * @param locales - Array of locale configurations
+ * @param defaultLocale - Default locale code
+ * @param navigate - Navigation function from @solidjs/router's useNavigate hook
+ * @param location - Location object from @solidjs/router's useLocation hook
+ * @returns I18nRoutingStrategy with reactive pathname accessor
+ */
+export declare function createSolidRouterAdapter(locales: Locale[], defaultLocale: string, navigate: NavigateFunction, location: Location_2): I18nRoutingStrategy & {
+    getCurrentPathAccessor: Accessor<string>;
+};
+
+export { defaultPlural }
+
+export { FormatService }
+
+export { Getter }
+
+export declare const I18nContext: Context<SolidI18n | undefined>;
+
+export declare const I18nDefaultLocaleContext: Context<string | undefined>;
+
+export declare const I18nGroup: Component<I18nGroupProps>;
+
+declare interface I18nGroupProps extends JSX.HTMLAttributes<HTMLDivElement> {
+    prefix: string;
+    groupClass?: string;
+}
+
+export declare const I18nLink: Component<I18nLinkProps>;
+
+declare interface I18nLinkProps extends JSX.AnchorHTMLAttributes<HTMLAnchorElement> {
+    to: string | {
+        path?: string;
+    };
+    localeRoute?: (to: string | {
+        path?: string;
+    }, locale?: string) => string | {
+        path?: string;
+    };
+    activeStyle?: JSX.CSSProperties;
+}
+
+export declare const I18nLocalesContext: Context<Locale[] | undefined>;
+
+export declare const I18nProvider: ParentComponent<I18nProviderProps>;
+
+export declare interface I18nProviderProps {
+    i18n: SolidI18n;
+    locales?: Locale[];
+    defaultLocale?: string;
+    routingStrategy?: I18nRoutingStrategy;
+}
+
+export declare const I18nRouterContext: Context<I18nRoutingStrategy | undefined>;
+
+/**
+ * Routing strategy interface for i18n
+ * Implement this interface to integrate with any router library
+ * Matches Vue package interface for consistency
+ */
+export declare interface I18nRoutingStrategy {
+    /**
+     * Returns current path (without locale prefix if needed, or full path)
+     * Used for determining active classes in links
+     * Note: For SolidJS, this should return the current value synchronously.
+     * For reactive updates, use `getCurrentPathAccessor` instead.
+     */
+    getCurrentPath: () => string;
+    /**
+     * (SolidJS-specific, highly recommended) Returns reactive accessor for current path
+     * This is REQUIRED for proper reactivity in SolidJS components.
+     * Without this, active link states and path-dependent UI won't update reactively.
+     *
+     * @example
+     * ```tsx
+     * const pathnameAccessor = router.getCurrentPathAccessor?.()
+     * // Use inside createMemo for reactivity:
+     * const currentPath = createMemo(() => pathnameAccessor?.() ?? router.getCurrentPath())
+     * ```
+     */
+    getCurrentPathAccessor?: () => Accessor<string>;
+    /**
+     * Component to use for rendering links (e.g., RouterLink)
+     */
+    linkComponent?: string | Component<{
+        href: string;
+        children?: JSX.Element;
+        style?: JSX.CSSProperties;
+        class?: string;
+        [key: string]: unknown;
+    }>;
+    /**
+     * Function to navigate to another route/locale
+     */
+    push: (target: {
+        path: string;
+    }) => void;
+    /**
+     * Function to replace current route
+     */
+    replace: (target: {
+        path: string;
+    }) => void;
+    /**
+     * Generate path for specific locale
+     */
+    resolvePath?: (to: string | {
+        path?: string;
+    }, locale: string) => string | {
+        path?: string;
+    };
+    /**
+     * (Optional) Get current route object for SEO/Meta tags
+     */
+    getRoute?: () => {
+        fullPath: string;
+        query: Record<string, unknown>;
+    };
+}
+
+export declare const I18nSwitcher: Component<I18nSwitcherProps>;
+
+declare interface I18nSwitcherProps extends JSX.HTMLAttributes<HTMLDivElement> {
+    locales?: Locale[];
+    currentLocale?: string | (() => string);
+    getLocaleName?: () => string | null;
+    switchLocale?: (locale: string) => void;
+    localeRoute?: (to: string | {
+        path?: string;
+    }, locale?: string) => string | {
+        path?: string;
+    };
+    customLabels?: Record<string, string>;
+    customWrapperStyle?: JSX.CSSProperties;
+    customButtonStyle?: JSX.CSSProperties;
+    customDropdownStyle?: JSX.CSSProperties;
+    customItemStyle?: JSX.CSSProperties;
+    customLinkStyle?: JSX.CSSProperties;
+    customActiveLinkStyle?: JSX.CSSProperties;
+    customDisabledLinkStyle?: JSX.CSSProperties;
+    customIconStyle?: JSX.CSSProperties;
+}
+
+export declare const I18nT: Component<I18nTProps>;
+
+declare interface I18nTProps extends JSX.HTMLAttributes<HTMLElement> {
+    keypath: TranslationKey;
+    params?: Record<string, string | number | boolean>;
+    tag?: string;
+    plural?: number | string;
+    defaultValue?: string;
+    html?: boolean;
+    hideIfEmpty?: boolean;
+    customPluralRule?: PluralFunc;
+    number?: number | string;
+    date?: Date | string | number;
+    relativeDate?: Date | string | number;
+}
+
+export { interpolate }
+
+export { Locale }
+
+export { LocaleCode }
+
+export { ModuleOptions }
+
+declare type NavigateFunction = ReturnType<typeof useNavigate>;
+
+export { Params }
+
+export { PluralFunc }
+
+export declare class SolidI18n extends BaseI18n {
+    private _locale;
+    private _setLocale;
+    private _fallbackLocale;
+    private _currentRoute;
+    private _setRoute;
+    readonly storage: TranslationStorage;
+    private listeners;
+    constructor(options: SolidI18nOptions);
+    getLocale(): string;
+    getFallbackLocale(): string;
+    getRoute(): string;
+    set locale(val: string);
+    get locale(): string;
+    get localeAccessor(): Accessor<string>;
+    get fallbackLocale(): string;
+    get currentRoute(): string;
+    get routeAccessor(): Accessor<string>;
+    setRoute(val: string): void;
+    addTranslations(locale: string, translations: Translations, merge?: boolean): void;
+    addRouteTranslations(locale: string, routeName: string, translations: Translations, merge?: boolean): void;
+    clearCache(): void;
+    subscribe(cb: () => void): () => void;
+    private notifyListeners;
+}
+
+export declare interface SolidI18nOptions {
+    locale: string;
+    fallbackLocale?: string;
+    messages?: Record<string, Translations>;
+    plural?: PluralFunc;
+    missingWarn?: boolean;
+    missingHandler?: (locale: string, key: string, routeName: string) => void;
+}
+
+export { TranslationKey }
+
+export { Translations }
+
+export declare function useI18n(options?: UseI18nOptions): {
+    instance: SolidI18n;
+    locale: Accessor<string>;
+    getLocales: () => Locale[];
+    defaultLocale: () => string;
+    getLocaleName: () => string | null;
+    localeRoute: (to: string | {
+        path?: string;
+    }, localeCode?: string) => string | {
+        path?: string;
+    };
+    localePath: (to: string | {
+        path?: string;
+    }, locale?: string) => string;
+    switchLocale: (newLocale: string) => void;
+    t: (key: TranslationKey, params?: Params, defaultValue?: string | null, routeName?: string) => CleanTranslation;
+    ts: (key: TranslationKey, params?: Params, defaultValue?: string, routeName?: string) => string;
+    tc: (key: TranslationKey, count: number | Params, defaultValue?: string) => string;
+    tn: (value: number, options?: Intl.NumberFormatOptions) => string;
+    td: (value: Date | number | string, options?: Intl.DateTimeFormatOptions) => string;
+    tdr: (value: Date | number | string, options?: Intl.RelativeTimeFormatOptions) => string;
+    has: (key: TranslationKey, routeName?: string) => boolean;
+    setRoute: (val: string) => void;
+    getRoute: () => string;
+    getLocale: () => string;
+    addTranslations: (locale: string, translations: Translations, merge?: boolean) => void;
+    addRouteTranslations: (locale: string, routeName: string, translations: Translations, merge?: boolean) => void;
+    clearCache: () => void;
+};
+
+export declare const useI18nContext: () => SolidI18n;
+
+export declare const useI18nDefaultLocale: () => string;
+
+export declare const useI18nLocales: () => Locale[];
+
+export declare interface UseI18nOptions {
+    locales?: Locale[];
+    defaultLocale?: string;
+}
+
+export declare const useI18nRouter: () => I18nRoutingStrategy | undefined;
+
+export { }

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { BaseI18n as dt } from "@i18n-micro/core";
 import { FormatService as Ot, defaultPlural as Wt, interpolate as Ht } from "@i18n-micro/core";
-import { spread as T, mergeProps as x, insert as S, memo as v, template as C, createComponent as k, delegateEvents as ft, use as ht, setAttribute as K, effect as W, style as I, className as pt, Dynamic as H } from "solid-js/web";
+import { spread as T, mergeProps as x, insert as S, memo as v, template as C, createComponent as k, use as ft, setAttribute as K, effect as W, style as I, className as ht, delegateEvents as pt, Dynamic as H } from "solid-js/web";
 import { createContext as E, useContext as j, splitProps as V, createMemo as P, createSignal as A, onMount as gt, onCleanup as mt, createEffect as yt } from "solid-js";
 import { A as vt } from "@solidjs/router";
 const Q = E(), U = E(), X = E(), Y = E(), D = () => {
@@ -200,7 +200,7 @@ const Nt = (r) => {
     document.removeEventListener("click", Z);
   }), (() => {
     var u = xt(), m = u.firstChild, R = m.firstChild, w = R.nextSibling;
-    return ht((d) => {
+    return ft((d) => {
       a = d;
     }, u), T(u, x({
       get style() {
@@ -231,7 +231,7 @@ const Nt = (r) => {
                 ...n.customLinkStyle,
                 ...N ? n.customActiveLinkStyle : {}
               };
-              return b.e = I(O, it, b.e), J !== b.t && pt($, b.t = J), b.a = I($, ut, b.a), b;
+              return b.e = I(O, it, b.e), J !== b.t && ht($, b.t = J), b.a = I($, ut, b.a), b;
             }, {
               e: void 0,
               t: void 0,
@@ -260,7 +260,7 @@ const Nt = (r) => {
     }), u;
   })();
 };
-ft(["click"]);
+pt(["click"]);
 const Tt = (r) => {
   const t = D(), [e, o] = V(r, ["keypath", "params", "tag", "plural", "defaultValue", "html", "hideIfEmpty", "customPluralRule", "number", "date", "relativeDate"]), n = P(() => {
     const h = t.localeAccessor(), c = t.routeAccessor();

package/package.json

@@ -1,23 +1,53 @@
 {
   "name": "@i18n-micro/solid",
-  "version": "1.2.0",
+  "version": "1.2.1",
+  "description": "SolidJS bindings for i18n-micro — primitives, context, and UI components.",
   "type": "module",
+  "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/s00d/nuxt-i18n-micro.git",
+    "directory": "packages/solid"
+  },
+  "homepage": "https://github.com/s00d/nuxt-i18n-micro/tree/main/packages/solid#readme",
+  "bugs": {
+    "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    }
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "solid",
+    "solidjs",
+    "i18n",
+    "internationalization",
+    "translations"
+  ],
   "peerDependencies": {
     "solid-js": "^1.9.10",
     "@solidjs/router": "^0.15.4"
@@ -31,13 +61,14 @@
     }
   },
   "dependencies": {
-    "@i18n-micro/core": "1.2.0",
-    "@i18n-micro/types": "1.1.5"
+    "@i18n-micro/core": "1.3.1",
+    "@i18n-micro/types": "1.2.2"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
+    "publint": "^0.3.17",
     "solid-js": "^1.9.10",
     "ts-jest": "^29.4.6",
     "vite": "^7.3.1",
@@ -46,6 +77,7 @@
   },
   "scripts": {
     "build": "vite build",
+    "check:package": "publint",
     "dev": "cd playground && vite",
     "test": "jest",
     "typecheck": "tsc --noEmit"