@siemens/element-translate-ng 47.0.0

package/translate/si-no-translate.service-builder.d.ts

@@ -0,0 +1,14 @@
+import { SiTranslateService } from './si-translate.service';
+import { SiTranslateServiceBuilder } from './si-translate.service-builder';
+import * as i0 from "@angular/core";
+/**
+ * Always returns the same instance of {@link SiNoTranslateService}
+ *
+ * @internal
+ */
+export declare class SiNoTranslateServiceBuilder extends SiTranslateServiceBuilder {
+    private siNoTranslateService;
+    buildService(): SiTranslateService;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiNoTranslateServiceBuilder, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiNoTranslateServiceBuilder>;
+}

package/translate/si-no-translate.service.d.ts

@@ -0,0 +1,21 @@
+import { Observable } from 'rxjs';
+import { SiTranslateService, TranslationResult } from './si-translate.service';
+import * as i0 from "@angular/core";
+/**
+ * Pass through implementation of the {@link SiTranslateService} which is used as a default.
+ *
+ * @internal
+ */
+export declare class SiNoTranslateService extends SiTranslateService {
+    get currentLanguage(): string;
+    get availableLanguages(): string[];
+    set availableLanguages(lang: string[]);
+    setCurrentLanguage(lang: string): Observable<void>;
+    getDefaultLanguage(): string;
+    setDefaultLanguage(lang: string): void;
+    translate<T extends string | string[]>(keys: T, _params?: Record<string, unknown>): TranslationResult<T>;
+    translateSync<T extends string | string[]>(keys: T, params?: Record<string, unknown>): TranslationResult<T>;
+    translateAsync<T extends string | string[]>(keys: T, params?: Record<string, unknown>): Observable<TranslationResult<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiNoTranslateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiNoTranslateService>;
+}

package/translate/si-translatable.model.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { InjectionToken } from '@angular/core';
+export declare const SI_TRANSLATABLE_VALUES: InjectionToken<Record<string, string>[]>;

package/translate/si-translatable.service.d.ts

@@ -0,0 +1,11 @@
+import { TranslatableString } from '@siemens/element-translate-ng/translate-types';
+import * as i0 from "@angular/core";
+export declare class SiTranslatableService {
+    private readonly translatableValues;
+    private readonly isNoTranslate;
+    private readonly siTranslateService;
+    constructor();
+    resolveText(key: string, originalText: string): TranslatableString;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTranslatableService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiTranslatableService>;
+}

package/translate/si-translate.module.d.ts

@@ -0,0 +1,14 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./si-translate.pipe";
+/**
+ * This provides declares SiTranslatePipe and provides a respective SiTranslateService.
+ * It should be used internally of Element but NOT by any application
+ *
+ * @internal
+ */
+export declare class SiTranslateModule {
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTranslateModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SiTranslateModule, [typeof i1.SiTranslatePipe], never, [typeof i1.SiTranslatePipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SiTranslateModule>;
+}

package/translate/si-translate.pipe.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { OnDestroy, PipeTransform } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * Translates keys by using the {@link SiTranslateService}.
+ * Within Element this pipe should be used instead of ngx-translates `translate` pipe.
+ * Outside Element, this pipe should NOT be used.
+ *
+ * @internal
+ */
+export declare class SiTranslatePipe implements PipeTransform, OnDestroy {
+    private lastKeyParams?;
+    private value;
+    private subscription?;
+    private siTranslateService;
+    private cdRef;
+    /**
+     * Method which is called on any data passed to the pipe.
+     * Called by Angular, should not be called directly.
+     */
+    transform(key: string, params?: any): string;
+    transform(key: string | null | undefined, params?: any): string | null | undefined;
+    ngOnDestroy(): void;
+    private updateValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTranslatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SiTranslatePipe, "translate", false>;
+}

package/translate/si-translate.service-builder.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { Injector } from '@angular/core';
+import { SiTranslateService } from './si-translate.service';
+import * as i0 from "@angular/core";
+/**
+ * Provide this class to build a custom translation service.
+ *
+ * @internal
+ */
+export declare abstract class SiTranslateServiceBuilder {
+    /**
+     * Returns a translation service instance.
+     * @param injector - Is used to retrieve dependencies needed to create the translation service.
+     */
+    abstract buildService(injector: Injector): SiTranslateService;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTranslateServiceBuilder, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiTranslateServiceBuilder>;
+}

package/translate/si-translate.service.d.ts

@@ -0,0 +1,96 @@
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export type TranslationResult<T> = T extends string ? string : Record<string, string>;
+/**
+ * @returns The culture language code of the browser, e.g. "en-US".
+ */
+export declare const getBrowserCultureLanguage: () => string | undefined;
+/**
+ * @returns The language code of the browser, e.g. "en".
+ */
+export declare const getBrowserLanguage: () => string | undefined;
+/**
+ * Wrapper around an actual translation framework which is meant to be used internally by Element.
+ * Applications must not use this service.
+ *
+ * @internal
+ */
+export declare abstract class SiTranslateService {
+    protected translationChange$: Observable<void>;
+    private documentRef;
+    prevent$LocalizeInit?: boolean;
+    /**
+     * The currently used language.
+     */
+    abstract get currentLanguage(): string;
+    /**
+     * Sets a new language to be used. If needed, loads the language file.
+     * @param lang - The language to be used.
+     * @returns An observable that emits when the new language is loaded and activated.
+     */
+    abstract setCurrentLanguage(lang: string): Observable<void>;
+    /**
+     * The language to be used as default.
+     * @param lang - The language code.
+     */
+    abstract setDefaultLanguage(lang: string): void;
+    /**
+     * The language to be used as default.
+     * @returns The code of the default language.
+     */
+    abstract getDefaultLanguage(): string;
+    /**
+     * The available languages.
+     */
+    abstract get availableLanguages(): string[];
+    abstract set availableLanguages(languages: string[]);
+    /**
+     * If the underlying translation library supports switching the language
+     * and/or updating the translation texts, this observable will emit.
+     * There is no initial emit.
+     */
+    get translationChange(): Observable<void>;
+    /**
+     * Translates the key(s) by using the underlying translation library.
+     *
+     * @param keys - A single translation key or an array of keys.
+     * @param params - Parameters to be replaced within the translation text.
+     *
+     * @returns Returns the translated key or an object with the translated keys.
+     * Depending on the underlying translation library (sync/async) the result will
+     * be wrapped in an Observable.
+     */
+    abstract translate<T extends string | string[]>(keys: T, params?: Record<string, unknown>): Observable<TranslationResult<T>> | TranslationResult<T>;
+    /**
+     * Translates the key(s) by using the underlying translation library in an asynchronous manner.
+     * It will emit each time the active language is changed.
+     *
+     * @param keys - A single translation key or an array of keys.
+     * @param params - Parameters to be replaced within the translation text.
+     *
+     * @returns Returns the translated key or an object with the translated keys wrapped in an Observable.
+     */
+    abstract translateAsync<T extends string | string[]>(keys: T, params?: Record<string, unknown>): Observable<TranslationResult<T>>;
+    /**
+     * Translates the key(s) by using the underlying translation library in a synchronous manner.
+     *
+     * Warning: The caller of this function needs to make sure the translation file(s) are already loaded.
+     * It is generally not recommended to use this function unless you know exactly what you are doing.
+     *
+     * @param keys - A single translation key or an array of keys.
+     * @param params - Parameters to be replaced within the translation text.
+     *
+     * @returns Returns the translated key or an object with the translated keys.
+     */
+    abstract translateSync<T extends string | string[]>(keys: T, params?: Record<string, unknown>): TranslationResult<T>;
+    /**
+     * If supported by the underlying translation library, this method can be used to add a translation for a specific key.
+     * It is intended to be used for adding the english default value.
+     * It will be called whenever a key within element is resolved.
+     * An implementation of this method must check that it does not override an existing translation.
+     */
+    setTranslation?(key: string, value: string): void;
+    setDocumentLanguage(lang: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiTranslateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SiTranslateService>;
+}

package/translate/testing/si-translate.mock-service-builder.factory.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import { Injector, Provider } from '@angular/core';
+import { SiTranslateService } from '../si-translate.service';
+export declare const provideMockTranslateServiceBuilder: (buildService: (injector: Injector) => SiTranslateService) => Provider;

package/translate-types/README.md

@@ -0,0 +1,6 @@
+# Entry point for @siemens/element development only
+
+`TranslatableString` must be in its own entry point as it is reused in `@siemens/element-localize-types` which itself is
+used as a types-package.
+Having `TranslatableString` in `@siemens/element-translate-ng/translation` causes the compiler to fail.
+Therefore, it is only reexported in `@siemens/element-translate-ng/translation`.

package/translate-types/global.types.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+/**
+ * Empty interface to represent translatable strings before they are translated.
+ * Needed so the TypeScript compiler doesn't strip away the {@link TranslatableString} type.
+ * Ignored by the documentation.
+ * @internal
+ */
+interface Translatable {
+}
+/**
+ * Represents a translatable string. This can either be a translation key, e.g. `ACTIONS.EDIT` that
+ * will be automatically translated when displayed on the UI or a pre-translated string, e.g. `Edit`.
+ * Equivalent to a normal string in usage and functionality.
+ */
+export type TranslatableString = string & Translatable;
+export {};

package/translate-types/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+export * from './global.types';

package/translate-types/package.json

@@ -0,0 +1,3 @@
+{
+  "module": "../fesm2022/siemens-element-translate-ng-translate-types.mjs"
+}