@umbraco-cms/backoffice 14.0.0-3aaba617 → 14.0.0-3e938fa1

package/dist-cms/libs/class-api/class.mixin.js

@@ -6,7 +6,7 @@ export const UmbClassMixin = (superClass) => {
         constructor(host, controllerAlias) {
             super();
             this._host = host;
-            this._controllerAlias = controllerAlias ?? undefined; // ?? Symbol();
+            this._controllerAlias = controllerAlias ?? Symbol(); // This will fallback to a Symbol, ensuring that this class is only appended to the controller host once.
         }
         getHostElement() {
             return this._host.getHostElement();

package/dist-cms/libs/controller-api/controller-host-element.mixin.d.ts

@@ -1,8 +1,14 @@
-import { HTMLElementConstructor } from '../extension-api/types.js';
-import { UmbControllerAlias } from './controller-alias.type.js';
-import { UmbControllerHost } from './controller-host.interface.js';
+import type { UmbLocalizeController } from '../localization-api/index.js';
+import type { HTMLElementConstructor } from '../extension-api/types.js';
+import type { UmbControllerAlias } from './controller-alias.type.js';
+import type { UmbControllerHost } from './controller-host.interface.js';
 import type { UmbController } from './controller.interface.js';
 export declare class UmbControllerHostElement extends HTMLElement implements UmbControllerHost {
+    /**
+     * Use the UmbLocalizeController to localize your element.
+     * @see UmbLocalizeController
+     */
+    localize: UmbLocalizeController;
     hasController(controller: UmbController): boolean;
     getControllers(filterMethod: (ctrl: UmbController) => boolean): UmbController[];
     addController(controller: UmbController): void;

package/dist-cms/libs/element-api/element.mixin.d.ts

@@ -2,11 +2,18 @@ import type { Observable } from '../../external/rxjs/index.js';
 import type { HTMLElementConstructor } from '../extension-api/index.js';
 import type { UmbControllerHostElement } from '../controller-api/index.js';
 import { UmbContextToken, UmbContextCallback, UmbContextConsumerController, UmbContextProviderController } from '../context-api/index.js';
-import { UmbObserverController } from '../observable-api/index.js';
+import { ObserverCallback, UmbObserverController } from '../observable-api/index.js';
 export declare class UmbElement extends UmbControllerHostElement {
+    /**
+     * @description Observe a RxJS source of choice.
+     * @param {Observable<T>} source RxJS source
+     * @param {method} callback Callback method called when data is changed.
+     * @return {UmbObserverController} Reference to a Observer Controller instance
+     * @memberof UmbElementMixin
+     */
     observe<T>(source: Observable<T> | {
         asObservable: () => Observable<T>;
-    }, callback: (_value: T) => void, unique?: string): UmbObserverController<T>;
+    }, callback: ObserverCallback<T>, unique?: string): UmbObserverController<T>;
     provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R>;
     consumeContext<R = unknown>(alias: string | UmbContextToken<R>, callback: UmbContextCallback<R>): UmbContextConsumerController<R>;
 }

package/dist-cms/libs/element-api/element.mixin.js

@@ -1,8 +1,23 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import { UmbControllerHostElementMixin } from '../controller-api/index.js';
 import { UmbContextConsumerController, UmbContextProviderController, } from '../context-api/index.js';
 import { UmbObserverController } from '../observable-api/index.js';
+import { UmbLocalizeController } from '../localization-api/index.js';
+import { property } from '../../external/lit/index.js';
 export const UmbElementMixin = (superClass) => {
     class UmbElementMixinClass extends UmbControllerHostElementMixin(superClass) {
+        constructor() {
+            super(...arguments);
+            // Make `dir` and `lang` reactive properties so they react to language changes:
+            this.dir = '';
+            this.lang = '';
+            this.localize = new UmbLocalizeController(this);
+        }
         /**
          * @description Observe a RxJS source of choice.
          * @param {Observable<T>} source RxJS source
@@ -34,5 +49,11 @@ export const UmbElementMixin = (superClass) => {
             return new UmbContextConsumerController(this, alias, callback);
         }
     }
+    __decorate([
+        property()
+    ], UmbElementMixinClass.prototype, "dir", void 0);
+    __decorate([
+        property()
+    ], UmbElementMixinClass.prototype, "lang", void 0);
     return UmbElementMixinClass;
 };

package/dist-cms/libs/extension-api/types.d.ts

@@ -78,6 +78,14 @@ export interface ManifestClass<ClassType = unknown> extends ManifestWithLoader<{
 export interface ManifestClassWithClassConstructor<T = unknown> extends ManifestClass<T> {
     class: ClassConstructor<T>;
 }
+export interface ManifestWithLoaderIncludingDefaultExport<T = unknown> extends ManifestWithLoader<{
+    default: T;
+} | Omit<object, 'default'>> {
+    /**
+     * The file location of the javascript file to load
+     */
+    js?: string;
+}
 export interface ManifestElement<ElementType extends HTMLElement = HTMLElement> extends ManifestWithLoader<{
     default: ClassConstructor<ElementType>;
 } | Omit<object, 'default'>> {

package/dist-cms/libs/localization-api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './registry/translation.registry.js';
+export * from './localize.controller.js';
+export { registerTranslation } from './manager.js';

package/dist-cms/libs/localization-api/index.js

@@ -0,0 +1,3 @@
+export * from './registry/translation.registry.js';
+export * from './localize.controller.js';
+export { registerTranslation } from './manager.js';

package/dist-cms/libs/localization-api/localize.controller.d.ts

@@ -0,0 +1,47 @@
+import { DefaultTranslationSet, FunctionParams, TranslationSet } from './manager.js';
+import { UmbController, UmbControllerHost } from '../controller-api/index.js';
+/**
+ * The UmbLocalizeController enables localization for your element.
+ *
+ * @see UmbLocalizeElement
+ * @example
+ * ```ts
+ * import { UmbLocalizeController } from './index.js';
+ *
+ * \@customElement('my-element')
+ * export class MyElement extends LitElement {
+ *   private localize = new UmbLocalizeController(this);
+ *
+ *   render() {
+ *     return html`<p>${this.localize.term('general_close')}</p>`;
+ *   }
+ * }
+ * ```
+ */
+export declare class UmbLocalizeController<TranslationType extends TranslationSet = DefaultTranslationSet> implements UmbController {
+    #private;
+    controllerAlias: symbol;
+    constructor(host: UmbControllerHost);
+    hostConnected(): void;
+    hostDisconnected(): void;
+    destroy(): void;
+    /**
+     * Gets the host element's directionality as determined by the `dir` attribute. The return value is transformed to
+     * lowercase.
+     */
+    dir(): string;
+    /**
+     * Gets the host element's language as determined by the `lang` attribute. The return value is transformed to
+     * lowercase.
+     */
+    lang(): string;
+    private getTranslationData;
+    /** Outputs a translated term. */
+    term<K extends keyof TranslationType>(key: K, ...args: FunctionParams<TranslationType[K]>): string;
+    /** Outputs a localized date in the specified format. */
+    date(dateToFormat: Date | string, options?: Intl.DateTimeFormatOptions): string;
+    /** Outputs a localized number in the specified format. */
+    number(numberToFormat: number | string, options?: Intl.NumberFormatOptions): string;
+    /** Outputs a localized time in relative format. */
+    relativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions): string;
+}

package/dist-cms/libs/localization-api/localize.controller.js

@@ -0,0 +1,125 @@
+/*
+This module is a modified copy of the original Shoelace localize package: https://github.com/shoelace-style/localize
+
+The original license is included below.
+
+Copyright (c) 2020 A Beautiful Site, LLC
+
+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.
+*/
+import { connectedElements, documentDirection, documentLanguage, fallback, translations, } from './manager.js';
+const LocalizeControllerAlias = Symbol();
+/**
+ * The UmbLocalizeController enables localization for your element.
+ *
+ * @see UmbLocalizeElement
+ * @example
+ * ```ts
+ * import { UmbLocalizeController } from './index.js';
+ *
+ * \@customElement('my-element')
+ * export class MyElement extends LitElement {
+ *   private localize = new UmbLocalizeController(this);
+ *
+ *   render() {
+ *     return html`<p>${this.localize.term('general_close')}</p>`;
+ *   }
+ * }
+ * ```
+ */
+export class UmbLocalizeController {
+    #host;
+    #hostEl;
+    constructor(host) {
+        this.controllerAlias = LocalizeControllerAlias;
+        this.#host = host;
+        this.#hostEl = host.getHostElement();
+        this.#host.addController(this);
+    }
+    hostConnected() {
+        if (connectedElements.has(this.#hostEl)) {
+            return;
+        }
+        connectedElements.add(this.#hostEl);
+    }
+    hostDisconnected() {
+        connectedElements.delete(this.#hostEl);
+    }
+    destroy() {
+        // We do not need to call delete here, as hostDisconnected is called when controller is removed.
+        //connectedElements.delete(this.host);
+        this.#host.removeController(this);
+        this.#hostEl = undefined;
+    }
+    /**
+     * Gets the host element's directionality as determined by the `dir` attribute. The return value is transformed to
+     * lowercase.
+     */
+    dir() {
+        return `${this.#hostEl.dir || documentDirection}`.toLowerCase();
+    }
+    /**
+     * Gets the host element's language as determined by the `lang` attribute. The return value is transformed to
+     * lowercase.
+     */
+    lang() {
+        return `${this.#hostEl.lang || documentLanguage}`.toLowerCase();
+    }
+    getTranslationData(lang) {
+        const locale = new Intl.Locale(lang);
+        const language = locale?.language.toLowerCase();
+        const region = locale?.region?.toLowerCase() ?? '';
+        const primary = translations.get(`${language}-${region}`);
+        const secondary = translations.get(language);
+        return { locale, language, region, primary, secondary };
+    }
+    /** Outputs a translated term. */
+    term(key, ...args) {
+        const { primary, secondary } = this.getTranslationData(this.lang());
+        let term;
+        // Look for a matching term using regionCode, code, then the fallback
+        if (primary && primary[key]) {
+            term = primary[key];
+        }
+        else if (secondary && secondary[key]) {
+            term = secondary[key];
+        }
+        else if (fallback && fallback[key]) {
+            term = fallback[key];
+        }
+        else {
+            return String(key);
+        }
+        if (typeof term === 'function') {
+            return term(...args);
+        }
+        if (typeof term === 'string') {
+            if (args.length > 0) {
+                // Replace placeholders of format "%index%" and "{index}" with provided values
+                term = term.replace(/(%(\d+)%|\{(\d+)\})/g, (match, _p1, p2, p3) => {
+                    const index = p2 || p3;
+                    return String(args[index] || match);
+                });
+            }
+        }
+        return term;
+    }
+    /** Outputs a localized date in the specified format. */
+    date(dateToFormat, options) {
+        dateToFormat = new Date(dateToFormat);
+        return new Intl.DateTimeFormat(this.lang(), options).format(dateToFormat);
+    }
+    /** Outputs a localized number in the specified format. */
+    number(numberToFormat, options) {
+        numberToFormat = Number(numberToFormat);
+        return isNaN(numberToFormat) ? '' : new Intl.NumberFormat(this.lang(), options).format(numberToFormat);
+    }
+    /** Outputs a localized time in relative format. */
+    relativeTime(value, unit, options) {
+        return new Intl.RelativeTimeFormat(this.lang(), options).format(value, unit);
+    }
+}

package/dist-cms/libs/localization-api/manager.d.ts

@@ -0,0 +1,18 @@
+import type { UmbTranslationEntry } from '../../packages/core/extension-registry/index.js';
+export type FunctionParams<T> = T extends (...args: infer U) => string ? U : [];
+export interface TranslationSet {
+    $code: string;
+    $dir: 'ltr' | 'rtl';
+}
+export interface DefaultTranslationSet extends TranslationSet {
+    [key: string]: UmbTranslationEntry;
+}
+export declare const connectedElements: Set<HTMLElement>;
+export declare const translations: Map<string, TranslationSet>;
+export declare let documentDirection: string;
+export declare let documentLanguage: string;
+export declare let fallback: TranslationSet;
+/** Registers one or more translations */
+export declare function registerTranslation(...translation: TranslationSet[]): void;
+/** Updates all localized elements that are currently connected */
+export declare function update(): void;

package/dist-cms/libs/localization-api/manager.js

@@ -0,0 +1,40 @@
+export const connectedElements = new Set();
+const documentElementObserver = new MutationObserver(update);
+export const translations = new Map();
+export let documentDirection = document.documentElement.dir || 'ltr';
+export let documentLanguage = document.documentElement.lang || navigator.language;
+export let fallback;
+// Watch for changes on <html lang>
+documentElementObserver.observe(document.documentElement, {
+    attributes: true,
+    attributeFilter: ['dir', 'lang'],
+});
+/** Registers one or more translations */
+export function registerTranslation(...translation) {
+    translation.map((t) => {
+        const code = t.$code.toLowerCase();
+        if (translations.has(code)) {
+            // Merge translations that share the same language code
+            translations.set(code, { ...translations.get(code), ...t });
+        }
+        else {
+            translations.set(code, t);
+        }
+        // The first translation that's registered is the fallback
+        if (!fallback) {
+            fallback = t;
+        }
+    });
+    update();
+}
+/** Updates all localized elements that are currently connected */
+export function update() {
+    documentDirection = document.documentElement.dir || 'ltr';
+    documentLanguage = document.documentElement.lang || navigator.language;
+    [...connectedElements.keys()].map((el) => {
+        if (typeof el.requestUpdate === 'function') {
+            // TODO: We might want to implement a specific Umbraco method for informing about this. and then make the default UmbLitElement call requestUpdate..? Cause then others can implement their own solution?
+            el.requestUpdate();
+        }
+    });
+}

package/dist-cms/libs/localization-api/registry/translation.registry.d.ts

@@ -0,0 +1,12 @@
+import { UmbBackofficeExtensionRegistry, UmbTranslationEntry } from '../../../packages/core/extension-registry/index.js';
+export type UmbTranslationsFlatDictionary = Record<string, UmbTranslationEntry>;
+export declare class UmbTranslationRegistry {
+    #private;
+    constructor(extensionRegistry: UmbBackofficeExtensionRegistry);
+    /**
+     * Load a language from the extension registry.
+     * @param locale The locale to load.
+     */
+    loadLanguage(locale: string): void;
+}
+export declare const umbTranslationRegistry: UmbTranslationRegistry;

package/dist-cms/libs/localization-api/registry/translation.registry.js

@@ -0,0 +1,58 @@
+import { registerTranslation } from '../manager.js';
+import { hasDefaultExport, loadExtension } from '../../extension-api/index.js';
+import { umbExtensionsRegistry, } from '../../../packages/core/extension-registry/index.js';
+import { Subject, combineLatest, map, distinctUntilChanged } from '../../../external/rxjs/index.js';
+export class UmbTranslationRegistry {
+    #currentLanguage = new Subject();
+    #currentLanguageUnique = this.#currentLanguage.pipe(map((x) => x.toLowerCase()), distinctUntilChanged());
+    constructor(extensionRegistry) {
+        combineLatest([this.#currentLanguageUnique, extensionRegistry.extensionsOfType('translations')]).subscribe(async ([userCulture, extensions]) => {
+            const locale = new Intl.Locale(userCulture);
+            const translations = await Promise.all(extensions
+                .filter((x) => x.meta.culture.toLowerCase() === locale.baseName.toLowerCase() ||
+                x.meta.culture.toLowerCase() === locale.language.toLowerCase())
+                .map(async (extension) => {
+                const innerDictionary = {};
+                // If extension contains a dictionary, add it to the inner dictionary.
+                if (extension.meta.translations) {
+                    for (const [dictionaryName, dictionary] of Object.entries(extension.meta.translations)) {
+                        this.#addOrUpdateDictionary(innerDictionary, dictionaryName, dictionary);
+                    }
+                }
+                // If extension contains a js file, load it and add the default dictionary to the inner dictionary.
+                const loadedExtension = await loadExtension(extension);
+                if (loadedExtension && hasDefaultExport(loadedExtension)) {
+                    for (const [dictionaryName, dictionary] of Object.entries(loadedExtension.default)) {
+                        this.#addOrUpdateDictionary(innerDictionary, dictionaryName, dictionary);
+                    }
+                }
+                // Notify subscribers that the inner dictionary has changed.
+                return {
+                    $code: userCulture,
+                    $dir: extension.meta.direction ?? 'ltr',
+                    ...innerDictionary,
+                };
+            }));
+            if (translations.length) {
+                registerTranslation(...translations);
+                // Set the document language
+                document.documentElement.lang = locale.baseName;
+                // Set the document direction to the direction of the primary language
+                document.documentElement.dir = translations[0].$dir ?? 'ltr';
+            }
+        });
+    }
+    /**
+     * Load a language from the extension registry.
+     * @param locale The locale to load.
+     */
+    loadLanguage(locale) {
+        this.#currentLanguage.next(locale);
+    }
+    #addOrUpdateDictionary(innerDictionary, dictionaryName, dictionary) {
+        for (const [key, value] of Object.entries(dictionary)) {
+            innerDictionary[`${dictionaryName}_${key}`] = value;
+        }
+    }
+}
+export const umbTranslationRegistry = new UmbTranslationRegistry(umbExtensionsRegistry);

package/dist-cms/libs/observable-api/deep-state.d.ts

@@ -10,6 +10,6 @@ import { BehaviorSubject } from '../../external/rxjs/index.js';
  */
 export declare class UmbDeepState<T> extends BehaviorSubject<T> {
     constructor(initialData: T);
-    getObservablePart<ReturnType>(mappingFunction: MappingFunction<T, ReturnType>, memoizationFunction?: MemoizationFunction<ReturnType>): import("rxjs/internal/Observable.js").Observable<ReturnType>;
+    asObservablePart<ReturnType>(mappingFunction: MappingFunction<T, ReturnType>, memoizationFunction?: MemoizationFunction<ReturnType>): import("rxjs/internal/Observable.js").Observable<ReturnType>;
     next(newData: T): void;
 }

package/dist-cms/libs/observable-api/deep-state.js

@@ -13,7 +13,7 @@ export class UmbDeepState extends BehaviorSubject {
     constructor(initialData) {
         super(deepFreeze(initialData));
     }
-    getObservablePart(mappingFunction, memoizationFunction) {
+    asObservablePart(mappingFunction, memoizationFunction) {
         return createObservablePart(this, mappingFunction, memoizationFunction);
     }
     next(newData) {

package/dist-cms/libs/observable-api/observer.controller.d.ts

@@ -1,8 +1,8 @@
-import { UmbObserver } from './observer.js';
+import { ObserverCallback, UmbObserver } from './observer.js';
 import { Observable } from '../../external/rxjs/index.js';
 import { UmbController, UmbControllerAlias, UmbControllerHost } from '../controller-api/index.js';
 export declare class UmbObserverController<T = unknown> extends UmbObserver<T> implements UmbController {
     _alias?: UmbControllerAlias;
     get controllerAlias(): UmbControllerAlias;
-    constructor(host: UmbControllerHost, source: Observable<T>, callback: (_value: T) => void, alias?: UmbControllerAlias);
+    constructor(host: UmbControllerHost, source: Observable<T>, callback: ObserverCallback<T>, alias?: UmbControllerAlias);
 }

package/dist-cms/libs/observable-api/observer.d.ts

@@ -1,7 +1,13 @@
 import { Observable } from '../../external/rxjs/index.js';
+export type ObserverCallbackStack<T> = {
+    next: (_value: T) => void;
+    error?: (_value: unknown) => void;
+    complete?: () => void;
+};
+export type ObserverCallback<T> = ((_value: T) => void) | ObserverCallbackStack<T>;
 export declare class UmbObserver<T> {
     #private;
-    constructor(source: Observable<T>, callback: (_value: T) => void);
+    constructor(source: Observable<T>, callback: ObserverCallback<T>);
     asPromise(): Promise<T>;
     hostConnected(): void;
     hostDisconnected(): void;