@umbraco-cms/backoffice 14.0.0-b0704cee → 14.0.0-c26a40c4

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/class-state.d.ts

@@ -1,6 +1,6 @@
 import { BehaviorSubject } from '../../external/rxjs/index.js';
-interface UmbClassStateData {
-    equal(otherClass: UmbClassStateData | undefined): boolean;
+export interface UmbClassStateData {
+    equal(otherClass: this | undefined): boolean;
 }
 /**
  * @export
@@ -12,4 +12,3 @@ export declare class UmbClassState<T extends UmbClassStateData | undefined> exte
     constructor(initialData: T);
     next(newData: T): void;
 }
-export {};

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

@@ -1,8 +1,9 @@
-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;
+    #private;
     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);
+    destroy(): void;
 }

package/dist-cms/libs/observable-api/observer.controller.js

@@ -1,11 +1,14 @@
 import { UmbObserver } from './observer.js';
 export class UmbObserverController extends UmbObserver {
+    #host;
+    #alias;
     get controllerAlias() {
-        return this._alias;
+        return this.#alias;
     }
     constructor(host, source, callback, alias) {
         super(source, callback);
-        this._alias = alias;
+        this.#host = host;
+        this.#alias = alias;
         // Lets check if controller is already here:
         // No we don't want this, as multiple different controllers might be looking at the same source.
         /*
@@ -16,4 +19,8 @@ export class UmbObserverController extends UmbObserver {
         */
         host.addController(this);
     }
+    destroy() {
+        super.destroy();
+        this.#host.removeController(this);
+    }
 }

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

@@ -1,8 +1,19 @@
 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);
-    asPromise(): Promise<T>;
+    constructor(source: Observable<T>, callback: ObserverCallback<T>);
+    /**
+     * provides a promise which is resolved ones the observer got a value that is not undefined.
+     * Notice this promise will resolve immediately if the Observable holds an empty array or empty string.
+     *
+     */
+    asPromise(): Promise<Exclude<T, undefined>>;
     hostConnected(): void;
     hostDisconnected(): void;
     destroy(): void;

package/dist-cms/libs/observable-api/observer.js

@@ -1,4 +1,3 @@
-import { lastValueFrom } from '../../external/rxjs/index.js';
 export class UmbObserver {
     #source;
     #callback;
@@ -7,8 +6,32 @@ export class UmbObserver {
         this.#source = source;
         this.#subscription = source.subscribe(callback);
     }
-    async asPromise() {
-        return await lastValueFrom(this.#source);
+    /**
+     * provides a promise which is resolved ones the observer got a value that is not undefined.
+     * Notice this promise will resolve immediately if the Observable holds an empty array or empty string.
+     *
+     */
+    asPromise() {
+        // Notice, we do not want to store and reuse the Promise, cause this promise guarantees that the value is not undefined when resolved. and reusing the promise would not ensure that.
+        return new Promise((resolve) => {
+            let initialCallback = true;
+            let wantedToClose = false;
+            const subscription = this.#source.subscribe((value) => {
+                if (value !== undefined) {
+                    if (initialCallback) {
+                        wantedToClose = true;
+                    }
+                    else {
+                        subscription.unsubscribe();
+                    }
+                    resolve(value);
+                }
+            });
+            initialCallback = false;
+            if (wantedToClose) {
+                subscription.unsubscribe();
+            }
+        });
     }
     hostConnected() {
         if (this.#subscription.closed) {
@@ -20,6 +43,11 @@ export class UmbObserver {
         //this.#subscription.unsubscribe();
     }
     destroy() {
-        this.#subscription.unsubscribe();
+        if (this.#subscription) {
+            this.#subscription.unsubscribe();
+            this.#source = undefined;
+            this.#callback = undefined;
+            this.#subscription = undefined;
+        }
     }
 }

package/dist-cms/mocks/data/data-type.data.js

@@ -4,7 +4,6 @@ import { createFolderTreeItem } from './utils.js';
 // TODO: investigate why we don't get an type as part of the DataTypeModel
 export const data = [
     {
-        $type: '',
         type: 'data-type',
         name: 'Folder 1',
         id: 'dt-folder1',
@@ -12,7 +11,6 @@ export const data = [
         isFolder: true,
     },
     {
-        $type: '',
         type: 'data-type',
         id: '0cc0eba1-9960-42c9-bf9b-60e150b429ae',
         parentId: null,
@@ -22,7 +20,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Text',
         id: 'dt-textBox',
@@ -37,7 +34,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Text Area',
         id: 'dt-textArea',
@@ -47,7 +43,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'My JS Property Editor',
         id: 'dt-custom',
@@ -57,7 +52,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Color Picker',
         id: 'dt-colorPicker',
@@ -113,7 +107,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Content Picker',
         id: 'dt-contentPicker',
@@ -128,7 +121,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Eye Dropper',
         id: 'dt-eyeDropper',
@@ -165,7 +157,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Multi URL Picker',
         id: 'dt-multiUrlPicker',
@@ -196,7 +187,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Multi Node Tree Picker',
         id: 'dt-multiNodeTreePicker',
@@ -206,7 +196,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Date Picker',
         id: 'dt-datePicker',
@@ -230,7 +219,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Date Picker With Time',
         id: 'dt-datePicker-time',
@@ -248,7 +236,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Time',
         id: 'dt-time',
@@ -267,7 +254,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Email',
         id: 'dt-email',
@@ -277,7 +263,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Multiple Text String',
         id: 'dt-multipleTextString',
@@ -296,7 +281,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Dropdown',
         id: 'dt-dropdown',
@@ -306,7 +290,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Slider',
         id: 'dt-slider',
@@ -341,7 +324,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Toggle',
         id: 'dt-toggle',
@@ -368,7 +350,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Tags',
         id: 'dt-tags',
@@ -387,7 +368,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Markdown Editor',
         id: 'dt-markdownEditor',
@@ -397,7 +377,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Radio Button List',
         id: 'dt-radioButtonList',
@@ -416,7 +395,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Checkbox List',
         id: 'dt-checkboxList',
@@ -435,7 +413,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Block List',
         id: 'dt-blockList',
@@ -445,7 +422,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Media Picker',
         id: 'dt-mediaPicker',
@@ -455,7 +431,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Image Cropper',
         id: 'dt-imageCropper',
@@ -465,7 +440,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Upload Field',
         id: 'dt-uploadField',
@@ -484,7 +458,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Block Grid',
         id: 'dt-blockGrid',
@@ -494,7 +467,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Collection View',
         id: 'dt-collectionView',
@@ -504,7 +476,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Icon Picker',
         id: 'dt-iconPicker',
@@ -514,7 +485,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Number Range',
         id: 'dt-numberRange',
@@ -524,7 +494,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Order Direction',
         id: 'dt-orderDirection',
@@ -534,7 +503,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Overlay Size',
         id: 'dt-overlaySize',
@@ -544,7 +512,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Rich Text Editor',
         id: 'dt-richTextEditor',
@@ -622,7 +589,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Label',
         id: 'dt-label',
@@ -632,7 +598,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Integer',
         id: 'dt-integer',
@@ -642,7 +607,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Decimal',
         id: 'dt-decimal',
@@ -657,7 +621,6 @@ export const data = [
         ],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'User Picker',
         id: 'dt-userPicker',
@@ -667,7 +630,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Member Picker',
         id: 'dt-memberPicker',
@@ -677,7 +639,6 @@ export const data = [
         values: [],
     },
     {
-        $type: '',
         type: 'data-type',
         name: 'Member Group Picker',
         id: 'dt-memberGroupPicker',
@@ -715,7 +676,6 @@ class UmbDataTypeData extends UmbEntityData {
             name: folder.name,
             id: folder.id,
             parentId: folder.parentId,
-            $type: 'FolderTreeItemResponseModel',
             isFolder: true,
             isContainer: false,
         };