@prozorro/prozorro-ui 0.1.24-beta → 0.2.0-beta

package/dist/services/PzTranslator/PzTranslator.d.ts

@@ -0,0 +1,29 @@
+import { PzTranslatorFn, PzTranslatorOptions, PzTranslatorParams, PzTranslatorText } from './types';
+/**
+ * Register the app translate function used by config-driven components.
+ * Call once at bootstrap, e.g.
+ * `setTranslator((key, params) => i18n.global.t(key, params), { autoTranslate: true })`.
+ */
+export declare const setTranslator: (fn: PzTranslatorFn, options?: PzTranslatorOptions) => void;
+/** Unregister the translator and revert to the identity fallback. */
+export declare const resetTranslator: () => void;
+/**
+ * Translate `key` through the registered translator. With no translator
+ * registered the key is returned unchanged, so the library renders exactly as
+ * it did before one was set.
+ */
+export declare const translate: (key: string, params?: PzTranslatorParams) => string;
+/**
+ * Wrap an i18n key as a lazy resolver for use inside a config, e.g.
+ * `{ id: "1", key: "price", labelKey: pzT("labels.price") }`. Resolution is
+ * deferred to render time, so the value follows the active locale. Passing the
+ * result of `i18n.t(...)` directly would instead freeze whatever string existed
+ * when the config module was evaluated.
+ */
+export declare const pzT: (key: string, params?: PzTranslatorParams) => (() => string);
+/**
+ * Resolve a component text field to a rendered string. Resolvers are called;
+ * bare strings are translated only when `autoTranslate` is enabled, otherwise
+ * they render verbatim.
+ */
+export declare const resolveText: (value?: PzTranslatorText | null) => string;

package/dist/services/PzTranslator/index.d.ts

@@ -0,0 +1,2 @@
+export { setTranslator, resetTranslator, translate, pzT, resolveText } from './PzTranslator';
+export type * from './types';

package/dist/services/PzTranslator/types.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Interpolation params forwarded to the app translator
+ * (e.g. `{ count: 3 }` for a "{count} обрано" message).
+ */
+export type PzTranslatorParams = Record<string, string | number>;
+/**
+ * App-supplied translate function. The library never imports an i18n package —
+ * consumers register their own, e.g. `(key, params) => i18n.global.t(key, params)`.
+ */
+export type PzTranslatorFn = (key: string, params?: PzTranslatorParams) => string;
+/**
+ * Lazy text leaf — evaluated at render time rather than when the config is
+ * authored, so translations stay reactive to locale changes. Build one with
+ * {@link pzT} instead of writing it by hand.
+ */
+export type PzTranslatorTextResolver = () => string;
+/**
+ * Any text field accepted by config-driven components: either a plain string or
+ * a lazy {@link PzTranslatorTextResolver}.
+ */
+export type PzTranslatorText = string | PzTranslatorTextResolver;
+export interface PzTranslatorOptions {
+    /**
+     * When `true`, bare strings in config text fields are also passed to the
+     * translator, so existing configs that already store i18n keys work without
+     * edits. When `false` (default) only {@link pzT} resolvers are translated and
+     * bare strings render verbatim.
+     */
+    autoTranslate?: boolean;
+}