@zucker-framework/i18n 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,22 @@
+Zucker Framework
+Copyright 2026 Lind and Zucker Framework contributors
+
+Licensed under the Apache License, Version 2.0. See LICENSE.
+
+The framework includes TypeScript adaptations and enhancements of concepts and
+implementations from hsweb-framework and jetlinks-community, both distributed
+under the Apache License, Version 2.0. Individual packages use different subsets
+of the framework. The TypeScript adaptations and Node.js integrations were
+modified for Zucker Framework; they are not the original upstream distribution.
+
+hsweb-framework
+https://github.com/hs-web/hsweb-framework
+Copyright 2020 http://hsweb.me
+
+jetlinks-community
+https://github.com/jetlinks/jetlinks-community
+
+See THIRD_PARTY_NOTICES for license texts and attribution for bundled dependencies
+and reference implementations relevant to this package. External dependencies
+remain subject to their own licenses. This NOTICE is informational and does not
+modify any license or grant rights to upstream trademarks.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,4 @@
+@zucker-framework/i18n
+
+No separately recorded third-party implementation is bundled in this package.
+External dependencies retain their own licenses; see NOTICE for framework attribution.

package/dist/index.d.mts

@@ -0,0 +1,282 @@
+import { NestInterceptor, ExecutionContext, CallHandler, Type, DynamicModule, InjectionToken, OptionalFactoryDependency } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { BusinessException } from '@zucker-framework/core';
+
+/**
+ * MessageSource — i18n message resolution interface.
+ */
+interface MessageSource {
+    getMessage(code: string, args?: unknown[], defaultMessage?: string, locale?: string): string;
+}
+/**
+ * FileMessageSource — loads messages from JSON files.
+ *
+ * Expected file structure: {basePath}/{locale}.json
+ * JSON format: flat key-value pairs, e.g. { "error.notFound": "Resource not found" }
+ *
+ * Supports message interpolation with positional args: "Hello {0}, welcome to {1}"
+ */
+declare class FileMessageSource implements MessageSource {
+    private readonly basePath;
+    private readonly logger;
+    private readonly messages;
+    private readonly defaultLocale;
+    constructor(basePath: string, options?: {
+        defaultLocale?: string;
+    });
+    getMessage(code: string, args?: unknown[], defaultMessage?: string, locale?: string): string;
+    private loadLocale;
+    private flatten;
+    private interpolate;
+    clearCache(): void;
+}
+/**
+ * CompositeMessageSource — aggregates multiple message sources.
+ * Checks sources in order, returns the first match.
+ */
+declare class CompositeMessageSource implements MessageSource {
+    private readonly sources;
+    constructor(sources: MessageSource[]);
+    getMessage(code: string, args?: unknown[], defaultMessage?: string, locale?: string): string;
+    addSource(source: MessageSource): void;
+    /**
+     * Add multiple sources at once.
+     */
+    addSources(sources: MessageSource[]): void;
+    /**
+     * Get the number of registered sources.
+     */
+    getSourceCount(): number;
+}
+
+/**
+ * LocaleContext -- uses AsyncLocalStorage to bind the current locale
+ * to the execution context (request scope).
+ */
+declare class LocaleContext {
+    private static defaultLocale;
+    static setDefault(locale: string): void;
+    static getCurrent(): string;
+    static run<T>(locale: string, fn: () => T): T;
+    static runAsync<T>(locale: string, fn: () => Promise<T>): Promise<T>;
+}
+/**
+ * NestJS interceptor that sets the locale from the Accept-Language header.
+ */
+declare class LocaleInterceptor implements NestInterceptor {
+    private readonly supportedLocales;
+    private readonly defaultLocale;
+    constructor(options?: {
+        supportedLocales?: string[];
+        defaultLocale?: string;
+    });
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+    private parseLocale;
+}
+
+/**
+ * I18nException — an exception whose message is resolved via i18n at response time.
+ *
+ * Stores a message code and interpolation args. The actual i18n resolution
+ * happens when getMessage() is called (typically in an exception filter).
+ */
+declare class I18nException extends BusinessException {
+    readonly i18nCode: string;
+    readonly i18nArgs: unknown[];
+    constructor(code: string, args?: unknown[], fallbackMessage?: string);
+}
+
+/**
+ * I18nSpec — supports nested i18n parameter resolution.
+ *
+ * Allows i18n message codes whose arguments themselves need i18n resolution.
+ *
+ * Reference: jetlinks I18nSpec
+ *
+ * @example
+ * ```ts
+ * const spec = I18nSpec.of('message.scene.term.full_name', 'Property: {0}/{1}',
+ *   'Temperature',
+ *   I18nSpec.of('message.property.recent', 'Current Value'),
+ * );
+ * const resolved = spec.resolve(messageSource);
+ * // => "Property: Temperature/Current Value" (or localized)
+ * ```
+ */
+declare class I18nSpec {
+    /** i18n message code; if empty, defaultMessage is returned as-is */
+    code?: string;
+    /** Fallback message when code is not found or not provided */
+    defaultMessage?: string;
+    /** Nested i18n-aware arguments */
+    args: I18nSpec[];
+    constructor(code?: string, defaultMessage?: string, args?: I18nSpec[]);
+    /**
+     * Create an I18nSpec with optional nested args.
+     * Args can be strings (treated as plain defaults) or I18nSpec instances.
+     */
+    static of(code: string, defaultMessage?: string, ...args: Array<string | I18nSpec>): I18nSpec;
+    /**
+     * Add a nested i18n argument.
+     */
+    withArg(code: string, defaultMessage?: string, ...args: Array<string | I18nSpec>): this;
+    /**
+     * Add an existing I18nSpec as a nested argument.
+     */
+    withArgSpec(spec: I18nSpec): this;
+    /**
+     * Resolve this spec to a final message using the given MessageSource.
+     * Recursively resolves nested args first.
+     */
+    resolve(messageSource: MessageSource, locale?: string): string;
+    /**
+     * Create a shallow copy of this spec.
+     */
+    copy(): I18nSpec;
+    private resolveMessage;
+}
+
+/**
+ * Format a message template with positional or named parameters.
+ *
+ * Supports positional arguments `{0}, {1}` and named arguments `{name}, {count}`.
+ *
+ * @example formatMessage('Hello {0}, you have {1} messages', ['Alice', 5])
+ * @example formatMessage('Hello {name}, you have {count} messages', { name: 'Alice', count: 5 })
+ */
+declare function formatMessage(template: string, params: unknown[] | Record<string, unknown>): string;
+/**
+ * Simple plural selection (ICU MessageFormat style).
+ *
+ * Chooses among `zero`, `one` and `other` forms based on `count`.
+ * The selected form is then interpolated with `{count}` replaced by the actual
+ * number (formatted according to `locale` when provided).
+ *
+ * @example pluralize(0, { zero: '没有消息', one: '1 条消息', other: '{count} 条消息' })
+ * @example pluralize(5, { zero: '没有消息', one: '1 条消息', other: '{count} 条消息' })
+ */
+declare function pluralize(count: number, forms: {
+    zero?: string;
+    one?: string;
+    other: string;
+}, locale?: string): string;
+/**
+ * Format a date using `Intl.DateTimeFormat`.
+ *
+ * @param date   Date instance or epoch-milliseconds timestamp
+ * @param style  Predefined date style — `'short'`, `'medium'` (default),
+ *               `'long'` or `'full'`
+ * @param locale BCP-47 locale tag; defaults to the current context locale
+ */
+declare function formatDate(date: Date | number, style?: 'short' | 'medium' | 'long' | 'full', locale?: string): string;
+/**
+ * Format a number using `Intl.NumberFormat`.
+ *
+ * @param value   The numeric value
+ * @param style   `'decimal'` (default), `'currency'` or `'percent'`
+ * @param options Additional options — currently only `currency` (ISO 4217 code,
+ *                required when `style` is `'currency'`)
+ * @param locale  BCP-47 locale tag; defaults to the current context locale
+ */
+declare function formatNumber(value: number, style?: 'decimal' | 'currency' | 'percent', options?: {
+    currency?: string;
+}, locale?: string): string;
+/**
+ * Format a date as a human-friendly relative time string
+ * (e.g. "3 hours ago", "in 2 days") using `Intl.RelativeTimeFormat`.
+ *
+ * @param date   Date instance or epoch-milliseconds timestamp
+ * @param locale BCP-47 locale tag; defaults to the current context locale
+ */
+declare function formatRelativeTime(date: Date | number, locale?: string): string;
+/**
+ * LocaleUtils — static utility for i18n message resolution.
+ *
+ * Provides convenient methods for resolving messages using the current locale
+ * context and a configured MessageSource.
+ */
+declare class LocaleUtils {
+    private static messageSource;
+    /**
+     * Set the global message source used by resolve helpers.
+     */
+    static setMessageSource(source: MessageSource): void;
+    /**
+     * Get the currently configured global message source.
+     */
+    static getMessageSource(): MessageSource | null;
+    /**
+     * Resolve a message using the current locale context.
+     */
+    static resolveMessage(code: string, ...args: unknown[]): string;
+    /**
+     * Resolve a message with a default fallback using the current locale context.
+     */
+    static resolveMessageWithDefault(code: string, defaultMessage: string, ...args: unknown[]): string;
+    /**
+     * Resolve a message using a specific MessageSource and the current locale.
+     */
+    static resolveMessageFrom(source: MessageSource, code: string, defaultMessage?: string, ...args: unknown[]): string;
+    /**
+     * Resolve a message using a specific locale (ignoring the context locale).
+     */
+    static resolveMessageForLocale(code: string, locale: string, defaultMessage?: string, ...args: unknown[]): string;
+    /**
+     * Execute a function within a specific locale context.
+     */
+    static doWith<T>(locale: string, fn: () => T): T;
+    /**
+     * Execute an async function within a specific locale context.
+     */
+    static doWithAsync<T>(locale: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * Get the current locale.
+     */
+    static current(): string;
+}
+
+/**
+ * @I18n(code) -- marks a field/property for i18n text resolution.
+ *
+ * When applied, the field value is treated as an i18n message code
+ * that should be resolved through the MessageSource at display time.
+ */
+declare function I18n(code: string): PropertyDecorator;
+/**
+ * Get the i18n code associated with a property.
+ */
+declare function getI18nCode(target: object, propertyKey: string | symbol): string | undefined;
+/**
+ * Check if a property has an i18n code.
+ */
+declare function hasI18n(target: object, propertyKey: string | symbol): boolean;
+
+declare const MESSAGE_SOURCE = "MESSAGE_SOURCE";
+interface I18nModuleOptions {
+    /** Path to message files directory */
+    basePath?: string;
+    /** Default locale */
+    defaultLocale?: string;
+    /** Supported locales */
+    supportedLocales?: string[];
+    /** Additional message sources */
+    messageSources?: MessageSource[];
+}
+interface I18nModuleAsyncOptions {
+    imports?: Array<Type | DynamicModule>;
+    useFactory?: (...args: unknown[]) => I18nModuleOptions | Promise<I18nModuleOptions>;
+    useClass?: Type<I18nModuleOptionsFactory>;
+    useExisting?: Type<I18nModuleOptionsFactory>;
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
+}
+interface I18nModuleOptionsFactory {
+    createI18nOptions(): I18nModuleOptions | Promise<I18nModuleOptions>;
+}
+declare class ZuckerI18nModule {
+    static forRoot(options?: I18nModuleOptions): DynamicModule;
+    static forRootAsync(options: I18nModuleAsyncOptions): DynamicModule;
+    private static buildProviders;
+    private static createAsyncProviders;
+}
+
+export { CompositeMessageSource, FileMessageSource, I18n, I18nException, type I18nModuleAsyncOptions, type I18nModuleOptions, type I18nModuleOptionsFactory, I18nSpec, LocaleContext, LocaleInterceptor, LocaleUtils, MESSAGE_SOURCE, type MessageSource, ZuckerI18nModule, formatDate, formatMessage, formatNumber, formatRelativeTime, getI18nCode, hasI18n, pluralize };