ngx-edu-sharing-ui 9.0.2 → 9.1.2

package/lib/services/app-container.service.d.ts

@@ -0,0 +1,43 @@
+import { NgZone } from '@angular/core';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Provides methods on the container that hosts the application.
+ *
+ * Usually, this will be `window`, but in case the application is embedded as a web component, it is
+ * a `HTMLElement`.
+ */
+export declare class AppContainerService {
+    private ngZone;
+    private scrollContainer?;
+    constructor(ngZone: NgZone);
+    init(appElement: HTMLElement): void;
+    /**
+     * Registers one or more events on the application's scroll container.
+     *
+     * Note that the callback will be called outside of ng zone, so you must wrap any action that
+     * should be reflected by Angular with `ngZone.run()`.
+     */
+    registerScrollEvents(callback: (event: Event) => void, until: Observable<void>, { events }?: {
+        events?: string[];
+    }): void;
+    /**
+     * Return true if there is a scrolling ancestor that encompasses the app other than the document
+     * element.
+     */
+    hasScrollContainer(): boolean;
+    /**
+     * Returns the nearest scrolling container element that encompasses the app if the app is
+     * embedded in another web page.
+     *
+     * If the app is served natively, returns the document element.
+     */
+    getScrollContainer(): HTMLElement;
+    getScrollContainer<T>({ fallback }: {
+        fallback: T;
+    }): T;
+    private registerScrollContainer;
+    private getNearestScrollingAncestor;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppContainerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppContainerService>;
+}

package/lib/services/node-entries.service.d.ts

@@ -1,13 +1,38 @@
 import { SelectionModel } from '@angular/cdk/collections';
-import { EventEmitter } from '@angular/core';
+import { EventEmitter, WritableSignal } from '@angular/core';
 import { BehaviorSubject } from 'rxjs';
-import { FetchEvent, GridConfig, InteractionType, ListDragGropConfig, ListEventInterface, ListOptions, ListSortConfig, NodeClickEvent, NodeEntriesDataType, NodeEntriesDisplayType } from '../node-entries/entries-model';
+import { ClickSource, FetchEvent, GridConfig, InteractionType, ListDragGropConfig, ListEventInterface, ListOptions, ListSortConfig, NodeClickEvent, NodeEntriesDataType, NodeEntriesDisplayType } from '../node-entries/entries-model';
 import { NodeDataSource } from '../node-entries/node-data-source';
 import { NodeEntriesGlobalService, PaginationStrategy } from '../node-entries/node-entries-global.service';
 import { OptionItem, Scope } from '../types/option-item';
 import { ListItem } from '../types/list-item';
 import { UIService } from './ui.service';
 import * as i0 from "@angular/core";
+/**
+ Custom selection model which adds the click source of the selection.
+ USED IN EXTENSIONS!
+ */
+export declare class CustomSelectionModel<T> extends SelectionModel<T> {
+    private _clickSource;
+    /**
+     * used in extensions
+     */
+    readonly changedClickSource: import("rxjs").Observable<{
+        clickSource: ClickSource;
+        source: SelectionModel<T>;
+        added: T[];
+        removed: T[];
+    }>;
+    deselect(...values: T[]): void;
+    toggle(value: T): void;
+    clear(): void;
+    select(...values: T[]): void;
+    /**
+     * used in extensions
+     * @param value
+     */
+    set clickSource(value: ClickSource);
+}
 export declare class NodeEntriesService<T extends NodeEntriesDataType> {
     private uiService;
     private entriesGlobal;
@@ -30,16 +55,15 @@ export declare class NodeEntriesService<T extends NodeEntriesDataType> {
     get columns(): ListItem[];
     set columns(value: ListItem[]);
     configureColumns: boolean;
-    /** Emits when the columns configuration changes through user interaction. */
-    columnsChange: EventEmitter<ListItem[]>;
     displayType: NodeEntriesDisplayType;
-    selection: SelectionModel<T>;
+    selection: CustomSelectionModel<T>;
     elementInteractionType: InteractionType;
     options$: BehaviorSubject<ListOptions>;
     get options(): ListOptions;
     set options(options: ListOptions);
     checkbox: boolean;
-    globalOptions: OptionItem[];
+    globalOptionsSubject: BehaviorSubject<OptionItem[]>;
+    set globalOptions(globalOptions: OptionItem[]);
     sortSubject: BehaviorSubject<ListSortConfig>;
     get sort(): ListSortConfig;
     set sort(value: ListSortConfig);
@@ -54,6 +78,7 @@ export declare class NodeEntriesService<T extends NodeEntriesDataType> {
     primaryInstance: boolean;
     singleClickHint: 'dynamic' | 'static';
     disableInfiniteScroll: boolean;
+    scrollGradientColor: WritableSignal<string>;
     constructor(uiService: UIService, entriesGlobal: NodeEntriesGlobalService);
     onClicked({ event, ...data }: NodeClickEvent<T> & {
         event: MouseEvent;

package/lib/services/node-helper.service.d.ts

@@ -1,4 +1,4 @@
-import { ApiHelpersService, ConfigService, NetworkService, Node } from 'ngx-edu-sharing-api';
+import { ApiHelpersService, ConfigService, User, NetworkService, Node } from 'ngx-edu-sharing-api';
 import { TranslateService } from '@ngx-translate/core';
 import * as Workflow from '../types/workflow';
 import { RepoUrlService } from './repo-url.service';
@@ -10,7 +10,8 @@ export declare class NodeHelperService {
     protected networkService: NetworkService;
     protected configService: ConfigService;
     protected repoUrlService: RepoUrlService;
-    constructor(translate: TranslateService, apiHelpersService: ApiHelpersService, networkService: NetworkService, configService: ConfigService, repoUrlService: RepoUrlService);
+    private assetsBasePath;
+    constructor(translate: TranslateService, apiHelpersService: ApiHelpersService, networkService: NetworkService, configService: ConfigService, repoUrlService: RepoUrlService, assetsBasePath: string);
     getCollectionScopeInfo(node: Node): {
         icon: string;
         scopeName: string;
@@ -41,16 +42,17 @@ export declare class NodeHelperService {
      * return the License URL (e.g. for CC_BY licenses) for a license string and version
      * @param licenseProperty
      * @param licenseVersion
+     * @param licenseLocale
      */
-    getLicenseUrlByString(licenseProperty: string, licenseVersion: string): any;
+    getLicenseUrlByString(licenseProperty: string, licenseVersion: string, licenseLocale: string): import("rxjs").Observable<string>;
     getWorkflowStatusById(id: string): Workflow.WorkflowDefinition;
     getWorkflowStatus(node: Node, useFromConfig?: boolean): Workflow.WorkflowDefinitionStatus;
     getDefaultWorkflowStatus(useFromConfig?: boolean): Workflow.WorkflowDefinitionStatus;
     getWorkflows(): Workflow.WorkflowDefinition[];
-    copyDataToNode<T extends Node>(target: T, source: T): void;
+    copyDataToNode<T extends Node | User>(target: T, source: T): void;
     isNodeCollection(node: Node): boolean;
     getSourceIconPath(src: string): string;
     getNodeLink(mode: 'routerLink' | 'queryParams', node: Node): string | Params;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NodeHelperService, never>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NodeHelperService, [null, null, null, null, null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NodeHelperService>;
 }

package/lib/services/options-helper-data.service.d.ts

@@ -1,6 +1,6 @@
-import { DropdownComponent } from '../dropdown/dropdown.component';
-import { ActionbarComponent } from '../actionbar/actionbar.component';
-import { ListEventInterface, NodeEntriesDataType, NodeEntriesDisplayType } from '../node-entries/entries-model';
+import type { DropdownComponent } from '../dropdown/dropdown.component';
+import type { ActionbarComponent } from '../actionbar/actionbar.component';
+import type { ListEventInterface, NodeEntriesDataType, NodeEntriesDisplayType } from '../node-entries/entries-model';
 import { EventEmitter, NgZone, OnDestroy } from '@angular/core';
 import { AuthenticationService, NetworkService, Node, UserService } from 'ngx-edu-sharing-api';
 import { CustomOptions, OptionItem, Scope, Target } from '../types/option-item';
@@ -56,12 +56,12 @@ export declare class OptionsHelperDataService implements OnDestroy {
     initComponents(actionbar?: ActionbarComponent, list?: ListEventInterface<NodeEntriesDataType>, dropdown?: DropdownComponent): Promise<void>;
     getData(): OptionData;
     setData(data: OptionData): void;
-    refreshComponents(refreshListOptions?: boolean): void;
-    getAvailableOptions(target: Target, objects?: Node[]): OptionItem[];
+    refreshComponents(refreshListOptions?: boolean): Promise<void>;
+    getAvailableOptions(target: Target, objects?: Node[]): Promise<OptionItem[]>;
     private addVirtualObjects;
     registerGlobalKeyboardShortcuts(): void;
     private handleKeyboardEvent;
-    filterOptions(options: OptionItem[], target: Target, objects?: Node[] | any): OptionItem[];
+    filterOptions(options: OptionItem[], target: Target, objects?: Node[] | any): Promise<OptionItem[]>;
     /**
      * shortcut to simply disable all options on the given compoennts
      * @param actionbar

package/lib/services/ui.service.d.ts

@@ -1,12 +1,13 @@
 import { ComponentFactoryResolver, ComponentRef, Injector, NgZone, Type, ViewContainerRef } from '@angular/core';
-import { Observable } from 'rxjs';
+import * as rxjs from 'rxjs';
+import { BehaviorSubject, Observable } from 'rxjs';
 import { OptionItem } from '../types/option-item';
 import * as i0 from "@angular/core";
 export declare class UIService {
     protected componentFactoryResolver: ComponentFactoryResolver;
     protected injector: Injector;
     protected ngZone: NgZone;
-    private isTouchSubject;
+    isTouchSubject: rxjs.BehaviorSubject<boolean>;
     private metaKeyPressedSubject;
     private shiftKeyPressedSubject;
     private ctrlKeyPressedSubject;
@@ -15,9 +16,21 @@ export declare class UIService {
     private onKeyDownOrKeyUp;
     private updateModifierKeys;
     observeCtrlOrCmdKeyPressedOutsideZone(): Observable<boolean>;
+    /**
+     * @Deprecated
+     * Prefer to subscribe to the isTouchSubject directly if viable
+     *
+     * Returns true if the current sessions seems to be running on a mobile device
+     */
     isMobile(): boolean;
     static evaluateMediaQuery(type: string, value: number): boolean;
     filterValidOptions(options: OptionItem[]): OptionItem[];
+    /**
+     * helper that updates the "isEnabled" flag on all options for the given, selected node
+     * can be used by dropdown or action menus to update the state for the current element
+     * @param options
+     */
+    updateOptionEnabledState(options: BehaviorSubject<OptionItem[]>, object?: Node | any): Promise<void>;
     filterToggleOptions(options: OptionItem[], toggle: boolean): OptionItem[];
     /**
      * dynamically inject an angular component into a regular html dom element

package/lib/spinner/spinner.component.d.ts

@@ -3,5 +3,5 @@ export declare class SpinnerComponent {
     readonly dataTest = "loading-spinner";
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<SpinnerComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SpinnerComponent, "es-spinner", never, {}, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpinnerComponent, "es-spinner", never, {}, {}, never, never, true, never>;
 }

package/lib/translations/translation-loader.d.ts

@@ -8,12 +8,13 @@ type Dictionary = {
     [key: string]: string | Dictionary;
 };
 export declare class TranslationLoader implements TranslateLoader {
+    private assetsBasePath;
     private http;
     private configService;
     private configuration;
     private prefix;
     private suffix;
-    static create(http: HttpClient, configService: ConfigService, configuration: EduSharingUiConfiguration): TranslationLoader;
+    static create(http: HttpClient, configService: ConfigService, configuration: EduSharingUiConfiguration, assetsBasePath?: string): TranslationLoader;
     private constructor();
     private readonly source;
     /**

package/lib/translations/translations.service.d.ts

@@ -1,3 +1,4 @@
+import { ApplicationRef } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
 import { TranslateService } from '@ngx-translate/core';
 import { Observable } from 'rxjs';
@@ -9,10 +10,12 @@ export declare class TranslationsService {
     private route;
     private storage;
     private translate;
+    private sessionStorage;
+    private ref;
     private appService;
     private language;
     private languageLoaded;
-    constructor(config: ConfigService, route: ActivatedRoute, storage: SessionStorageService, translate: TranslateService, appService: AppService);
+    constructor(config: ConfigService, route: ActivatedRoute, storage: SessionStorageService, translate: TranslateService, sessionStorage: SessionStorageService, ref: ApplicationRef, appService: AppService);
     /**
      * Determines and configures the language to use and triggers loading of translations with
      * ngx-translate.
@@ -25,6 +28,6 @@ export declare class TranslationsService {
     /** Same as `translate.currentLang`. */
     getLanguage(): string;
     getISOLanguage(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TranslationsService, [null, null, null, null, { optional: true; }]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslationsService, [null, null, null, null, null, null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TranslationsService>;
 }

package/lib/types/injection-tokens.d.ts

@@ -0,0 +1,8 @@
+import { InjectionToken } from '@angular/core';
+/**
+ * A custom base path for the assets directory.
+ *
+ * This is useful when the application cannot be served from the base HREF set in index.html. This
+ * is the case when it is embedded as a web component into another website.
+ */
+export declare const ASSETS_BASE_PATH: InjectionToken<string>;

package/lib/types/option-item.d.ts

@@ -8,8 +8,7 @@
 import { KeyboardShortcutCondition } from '../types/keyboard-shortcuts';
 export declare enum NodesRightMode {
     Local = 0,
-    Original = 1,
-    Both = 2
+    Effective = 1
 }
 export declare class OptionItem {
     name: string;
@@ -49,6 +48,11 @@ export declare class OptionItem {
      * @type {boolean}
      */
     onlyMobile: boolean;
+    /**
+     * custom aria-label
+     * @type {string}
+     */
+    ariaLabel: string;
     /**
      * If true, only displayed on a desktop device (based on the navigator agent)
      * @type {boolean}
@@ -79,23 +83,23 @@ export declare class OptionItem {
      * Is handled by optionsHelper and may not be used otherwise
      * Please use @customShowCallback instead
      */
-    showCallback: (node?: Node | any) => boolean;
+    showCallback: (node?: Node | any) => Promise<boolean>;
     /**
      * A function called with the node as parm which should return true or false if the option should be shown for this node
      * Will be called by the optionsHelper
      */
-    customShowCallback: (nodes?: Node[] | any[]) => boolean;
+    customShowCallback: (nodes?: Node[] | any[]) => Promise<boolean>;
     /**
      * A function called with the node as param which should return true or false if the option should be enabled or not
      * Is handled by optionsHelper and may not be used otherwise
      * Please use @customEnabledCallback instead
      */
-    enabledCallback: (node?: Node | any) => boolean;
+    enabledCallback: (node?: Node | any) => Promise<boolean>;
     /**
      * A function called with the node as param which should return true or false if the option should be enabled or not
      * Will be called by the optionsHelper
      */
-    customEnabledCallback: (nodes?: Node[] | any[]) => boolean;
+    customEnabledCallback: (nodes?: Node[] | any[]) => Promise<boolean>;
     /**
      *   Optional: A callback that is called when the user clicks on the option when it's currently disabled (greyed out)
      */

package/module.d.ts

@@ -1,72 +1,80 @@
-export * from './lib/edu-sharing-ui.module';
-export * from './lib/edu-sharing-ui-configuration';
-export * from './lib/translations/fallback-translation-handler';
-export * from './lib/translations/translation-loader';
+export * from './lib/actionbar/actionbar.component';
 export * from './lib/common/edu-sharing-ui-common.module';
-export * from './lib/translations/translations.module';
-export * from './lib/translations/translations.service';
-export * from './lib/node-entries/node-data-source';
-export * from './lib/node-entries/node-data-source-remote';
-export * from './lib/node-entries/items-cap';
-export * from './lib/node-entries/combined-data-source';
-export * from './lib/node-entries/entries-model';
-export * from './lib/node-entries/node-entries-global.service';
-export * from './lib/node-entries/node-cache';
-export * from './lib/node-entries/node-entries.module';
-export * from './lib/node-entries/node-entries-wrapper.component';
-export * from './lib/node-entries/list-item-label.pipe';
-export * from './lib/directives/icon.directive';
+export * from './lib/mds/mds.module';
 export * from './lib/directives/border-box-observer.directive';
+export * from './lib/directives/check-text-overflow.directive';
 export * from './lib/directives/drag-nodes/drag-nodes';
-export * from './lib/directives/drag-nodes/nodes-drop-target.directive';
 export * from './lib/directives/drag-nodes/nodes-drag-source.directive';
 export * from './lib/directives/drag-nodes/nodes-drag.directive';
-export * from './lib/directives/check-text-overflow.directive';
+export * from './lib/directives/drag-nodes/nodes-drop-target.directive';
 export * from './lib/directives/focus-state.directive';
-export * from './lib/sort-dropdown/sort-dropdown.component';
-export * from './lib/actionbar/actionbar.component';
-export * from './lib/list-items/list-items.module';
-export * from './lib/list-items/list-text/list-text.component';
+export * from './lib/directives/icon.directive';
+export * from './lib/directives/infinite-scroll.directive';
+export * from './lib/dropdown/dropdown.component';
+export * from './lib/edu-sharing-ui-configuration';
+export * from './lib/edu-sharing-ui.module';
+export * from './lib/list-items/format-duration.pipe';
 export * from './lib/list-items/list-base/list-base.component';
 export * from './lib/list-items/list-counts/list-counts.component';
-export * from './lib/list-items/format-duration.pipe';
+export * from './lib/list-items/list-items.module';
+export * from './lib/list-items/list-text/list-text.component';
 export * from './lib/list-items/node-row/node-row.component';
+export * from './lib/node-entries/combined-data-source';
+export * from './lib/node-entries/custom-templates-data-source';
+export * from './lib/node-entries/entries-model';
+export * from './lib/node-entries/items-cap';
+export * from './lib/node-entries/list-item-label.pipe';
+export * from './lib/node-entries/node-cache';
+export * from './lib/node-entries/node-data-source';
+export * from './lib/node-entries/node-data-source-remote';
+export * from './lib/node-entries/node-entries-global.service';
+export * from './lib/node-entries/node-entries-wrapper.component';
+export * from './lib/node-entries/node-entries.module';
+export * from './lib/node-url/node-url.component';
+export * from './lib/pipes/property-slug.pipe';
+export * from './lib/pipes/file-size.pipe';
 export * from './lib/pipes/format-date.pipe';
-export * from './lib/pipes/vcard-name.pipe';
 export * from './lib/pipes/node-icon.pipe';
-export * from './lib/pipes/node-image.pipe';
 export * from './lib/pipes/node-image-size.pipe';
-export * from './lib/pipes/file-size.pipe';
+export * from './lib/pipes/node-image.pipe';
 export * from './lib/pipes/node-person-name.pipe';
 export * from './lib/pipes/node-title.pipe';
+export * from './lib/pipes/vcard-name.pipe';
 export * from './lib/services/abstract/app.service';
-export * from './lib/services/abstract/options-helper.service';
 export * from './lib/services/abstract/keyboard-shortcuts.service';
+export * from './lib/services/abstract/options-helper.service';
 export * from './lib/services/abstract/toast.service';
-export * from './lib/services/local-events.service';
-export * from './lib/services/ui.service';
 export * from './lib/services/accessibility.service';
+export * from './lib/services/app-container.service';
+export * from './lib/services/local-events.service';
+export * from './lib/services/node-helper.service';
 export * from './lib/services/nodes-drag-drop.service';
 export * from './lib/services/options-helper-data.service';
-export * from './lib/services/temporary-storage.service';
-export * from './lib/services/node-helper.service';
 export * from './lib/services/repo-url.service';
-export * from './lib/types/workflow';
+export * from './lib/services/temporary-storage.service';
+export * from './lib/services/ui.service';
+export * from './lib/sort-dropdown/sort-dropdown.component';
+export * from './lib/spinner/spinner.component';
+export * from './lib/translations/fallback-translation-handler';
+export * from './lib/translations/translation-loader';
+export * from './lib/translations/translations.module';
+export * from './lib/translations/translations.service';
+export * from './lib/types/api-models';
+export * from './lib/types/accessibillity';
 export * from './lib/types/drag-drop';
-export * from './lib/types/option-item';
+export * from './lib/types/injection-tokens';
 export * from './lib/types/keyboard-shortcuts';
 export * from './lib/types/list-item';
-export * from './lib/types/accessibillity';
-export * from './lib/util/color-helper';
+export * from './lib/types/option-item';
+export * from './lib/types/workflow';
+export * from './lib/util/DateHelper';
 export * from './lib/util/VCard';
+export * from './lib/util/color-helper';
+export * from './lib/util/duration-helper';
 export * from './lib/util/functions';
-export * from './lib/util/DateHelper';
 export * from './lib/util/helper';
+export * from './lib/util/isNumeric';
 export * from './lib/util/rest-helper';
-export * from './lib/util/duration-helper';
 export * from './lib/util/ui-animation';
 export * from './lib/util/ui-constants';
-export * from './lib/util/isNumeric';
-export * from './lib/spinner/spinner.component';
-export * from './lib/node-url/node-url.component';
-export * from './lib/dropdown/dropdown.component';
+export * from './lib/mds/mds-helper.service';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-edu-sharing-ui",
-  "version": "9.0.2",
+  "version": "9.1.2",
   "license": "GNU GPL v2",
   "description": "Angular components for Edu-Sharing UX parts",
   "peerDependencies": {

package/esm2022/lib/translations/languages.mjs

@@ -1,5 +0,0 @@
-export const LANGUAGES = {
-    de: 'de_DE',
-    en: 'en_US',
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGFuZ3VhZ2VzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vcHJvamVjdHMvZWR1LXNoYXJpbmctdWkvc3JjL2xpYi90cmFuc2xhdGlvbnMvbGFuZ3VhZ2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBOEI7SUFDaEQsRUFBRSxFQUFFLE9BQU87SUFDWCxFQUFFLEVBQUUsT0FBTztDQUNkLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBMb2NhbGUgfSBmcm9tICduZ3gtZWR1LXNoYXJpbmctYXBpJztcblxuZXhwb3J0IGNvbnN0IExBTkdVQUdFUzogeyBba2V5OiBzdHJpbmddOiBMb2NhbGUgfSA9IHtcbiAgICBkZTogJ2RlX0RFJyxcbiAgICBlbjogJ2VuX1VTJyxcbn07XG4iXX0=

package/lib/translations/languages.d.ts

@@ -1,4 +0,0 @@
-import { Locale } from 'ngx-edu-sharing-api';
-export declare const LANGUAGES: {
-    [key: string]: Locale;
-};