ngx-edu-sharing-ui 0.7.0 → 9.0.1

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

@@ -0,0 +1,236 @@
+/**
+ * A option from the actionbar+dropdown menu
+ * Example:
+ this.options.push(new OptionItem("RESTORE_SINGLE","undo", (node) => this.restoreSingle(node)));
+ this.options.push(new OptionItem("DELETE_SINGLE","archiveDelete", (node) => this.deleteSingle(node)));
+
+ */
+import { KeyboardShortcutCondition } from '../types/keyboard-shortcuts';
+export declare enum NodesRightMode {
+    Local = 0,
+    Original = 1,
+    Both = 2
+}
+export declare class OptionItem {
+    name: string;
+    icon: string;
+    callback: (object?: Node | any, objects?: (Node | any)[]) => void;
+    /**
+     * If true, this option will be shown all the time in the node table
+     * @type {boolean}
+     */
+    showAlways: boolean;
+    /**
+     * If true, this option will be shown as an action (if room). If none of the items has showAsAction set, the first items will always be shown as action
+     * @type {boolean}
+     */
+    showAsAction: boolean;
+    /**
+     * If true, this option will be shown as a toggle on the right side (provide iconToggle as a toggle icon)
+     * @type {boolean}
+     */
+    isToggle: boolean;
+    /**
+     * If true, shows a line at the top.
+     *
+     * This feature is usually handled now by associating an entry to a `group`
+     * now. However `isSeparate` is kept as fallback for now.
+     */
+    isSeparate: boolean;
+    /**
+     * The item will be indicated with an accent color in the menu.
+     *
+     * Used by the dropdown variant of the main menu to indicate the currently
+     * active scope.
+     */
+    isSelected: boolean;
+    /**
+     * If true, only displayed on a mobile device (based on the navigator agent)
+     * @type {boolean}
+     */
+    onlyMobile: boolean;
+    /**
+     * If true, only displayed on a desktop device (based on the navigator agent)
+     * @type {boolean}
+     */
+    onlyDesktop: boolean;
+    /**
+     * You can set a media-query similar to CSS, see the MEDIA_QUERY constants in ui-constants
+     * Use in combination with mediaQueryValue
+     * @type {boolean}
+     */
+    mediaQueryType: string;
+    /**
+     * The value for the defined media query
+     */
+    mediaQueryValue: number;
+    /**
+     * Set to false if the action should be shown, but should not be clickable
+     * @type {boolean}
+     */
+    isEnabled: boolean;
+    /**
+     * Whether the option should be manually marked as primary action when always visible on an
+     * `actionbar`.
+     */
+    isPrimary: boolean;
+    /**
+     * A function called with the node as param which should return true or false if the option should be shown for this node
+     * Is handled by optionsHelper and may not be used otherwise
+     * Please use @customShowCallback instead
+     */
+    showCallback: (node?: Node | any) => 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     *   Optional: A callback that is called when the user clicks on the option when it's currently disabled (greyed out)
+     */
+    disabledCallback: (node?: Node | any) => void;
+    /**
+     *   Show the given name (if false, only icon will show)
+     */
+    showName: boolean;
+    /**
+     * element with 0 has highest priority in it's group, higher values mean lower priority
+     */
+    priority: number;
+    /**
+     * the group this option belongs to
+     */
+    group: OptionGroup;
+    keyboardShortcut: KeyboardShortcutCondition;
+    /**
+     * Or concat of supported element types for the action
+     */
+    elementType: ElementType[];
+    permissions: string[];
+    constrains: Constrain[];
+    permissionsMode: HideMode;
+    permissionsRightMode: NodesRightMode;
+    toolpermissions: string[];
+    toolpermissionsMode: HideMode;
+    scopes: Scope[];
+    /**
+     *
+     * @param name the option name, which is used for the translation
+     * @param icon A material icon name
+     * @param callback A function callback when this option is chosen. Will get the current node
+     * passed as an argument. If available, the relevant nodes are passed as second argument,
+     * i.e., the selection, if any, or the current node as single-item array otherwise.
+     */
+    constructor(name: string, icon: string, callback: (object?: Node | any, objects?: (Node | any)[]) => void);
+}
+export declare class CustomOptions {
+    /**
+     * If true, all existing or available options for the object stay
+     * If false, no options will be set, only the options in "addOptions" are used
+     */
+    useDefaultOptions?: boolean;
+    /**
+     * List of ids of options to explicitly support
+     */
+    supportedOptions?: string[];
+    /**
+     * List of ids of options to explicitly remove
+     * Only supported if supportedOptions is empty
+     */
+    removeOptions?: string[];
+    /**
+     * Options to add/insert into the menu
+     */
+    addOptions?: OptionItem[];
+}
+export declare enum HideMode {
+    Disable = 0,
+    Hide = 1
+}
+export declare enum Scope {
+    Render = "Render",
+    Search = "Search",
+    SearchCollections = "SearchCollections",
+    SavedSearches = "SavedSearches",
+    CollectionsReferences = "CollectionsReferences",
+    CollectionsProposals = "CollectionsProposals",
+    CollectionsCollection = "CollectionsCollection",
+    WorkspaceList = "WorkspaceList",
+    WorkspaceTree = "WorkspaceTree",
+    Sharing = "Sharing",
+    Oer = "Oer",
+    UserManagement = "UserManagement",
+    Stream = "Stream",
+    CreateMenu = "CreateMenu",
+    MediacenterNodesList = "MediacenterNodesList",
+    Admin = "Admin"
+}
+export declare enum ElementType {
+    Node = 0,
+    NodeChild = 1,
+    MapRef = 2,
+    NodePublishedCopy = 3,
+    NodeBlockedImport = 4,
+    NodeProposal = 5,
+    Person = 6,
+    Group = 7,
+    SavedSearch = 8,
+    Unknown = 9
+}
+export declare class OptionGroup {
+    id: string;
+    priority: number;
+    /**
+     * @param id The group identifier. Used to seperate elements based on the group
+     * @param priority Group with 0 has highest priority, higher values mean lower priority
+     */
+    constructor(id: string, priority: number);
+}
+export declare class DefaultGroups {
+    static Primary: OptionGroup;
+    static Create: OptionGroup;
+    static View: OptionGroup;
+    static CreateConnector: OptionGroup;
+    static CreateLtiTools: OptionGroup;
+    static Reuse: OptionGroup;
+    static Edit: OptionGroup;
+    static FileOperations: OptionGroup;
+    static Delete: OptionGroup;
+    static Toggles: OptionGroup;
+}
+export declare enum Constrain {
+    CollectionReference = 0,
+    NoCollectionReference = 1,
+    Directory = 2,
+    Collections = 3,
+    Files = 4,
+    FilesAndDirectories = 5,
+    Admin = 6,
+    AdminOrDebug = 7,
+    NoBulk = 8,
+    NoSelection = 9,
+    ClipboardContent = 10,
+    AddObjects = 11,
+    HomeRepository = 12,
+    User = 13,
+    NoScope = 14,
+    ReurlMode = 15,
+    LTIMode = 16
+}
+export declare enum Target {
+    List = 0,
+    ListDropdown = 1,
+    Actionbar = 2,
+    CreateMenu = 3
+}

package/lib/types/workflow.d.ts

@@ -0,0 +1,14 @@
+export interface WorkflowDefinition {
+    id: string;
+    color: string;
+    hasReceiver: boolean;
+    next: string[];
+}
+export declare const WORKFLOW_STATUS_UNCHECKED: WorkflowDefinition;
+export declare const WORKFLOW_STATUS_TO_CHECK: WorkflowDefinition;
+export declare const WORKFLOW_STATUS_HASFLAWS: WorkflowDefinition;
+export declare const WORKFLOW_STATUS_CHECKED: WorkflowDefinition;
+export type WorkflowDefinitionStatus = {
+    current: WorkflowDefinition;
+    initial: WorkflowDefinition;
+};

package/lib/util/DateHelper.d.ts

@@ -0,0 +1,44 @@
+import { TranslateService } from '@ngx-translate/core';
+export declare enum RelativeMode {
+    off = 0,
+    short = 1,
+    medium = 2,
+    large = 3,
+    all = 4
+}
+export declare class FormatOptions {
+    showDate?: boolean;
+    showAlwaysTime?: boolean;
+    showSeconds?: boolean;
+    useRelativeLabels?: boolean;
+    relativeLabels?: RelativeMode;
+}
+export declare class DateHelper {
+    /**
+     * Fill a date (day + month) string, e.g. 2 -> 02
+     * @param date
+     * @returns {string}
+     */
+    private static fillDate;
+    /**
+     * Convert date to a unix timestamp
+     * @param date
+     * @returns {number}
+     */
+    static convertDate(date: any): number;
+    /**
+     * format a date with a given, fixed string
+     * For consistency, we use the patterns from
+     * https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
+     * @param date
+     * @param {string} format
+     * @returns {string}
+     */
+    static formatDateByPattern(date: number | any, format: string): string;
+    /**
+     * Format a date for the current language
+     */
+    static formatDate(translation: TranslateService, date: number | any, options?: FormatOptions): string;
+    static getDateFromDatepicker(date: Date): Date;
+    static getDateForNewFile(): string;
+}

package/lib/util/VCard.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Created by Torsten on 28.02.2017.
+ */
+export declare class VCard {
+    static TYPE_PERSON: number;
+    static TYPE_ORG: number;
+    private isDirty;
+    private lines;
+    constructor(vcard?: string);
+    /**
+     * returns true if this vcard seems to have valid data
+     * @param {string} data
+     */
+    isValid(): string;
+    set givenname(data: string);
+    set surname(data: string);
+    set title(data: string);
+    set org(data: string);
+    set orgPhone(data: string);
+    set url(data: string);
+    set email(data: string);
+    set uid(data: string);
+    set orcid(data: string);
+    set gnduri(data: string);
+    set ror(data: string);
+    set wikidata(data: string);
+    set street(data: string);
+    set city(data: string);
+    set region(data: string);
+    set zip(data: string);
+    set country(data: string);
+    set contributeDate(data: string);
+    get givenname(): string;
+    get surname(): string;
+    get orcid(): string;
+    get gnduri(): string;
+    get ror(): string;
+    get wikidata(): string;
+    get title(): string;
+    get org(): string;
+    get contributeDate(): string;
+    get url(): string;
+    get orgPhone(): string;
+    get email(): string;
+    get uid(): string;
+    get street(): string;
+    get city(): string;
+    get region(): string;
+    get zip(): string;
+    get country(): string;
+    toVCardString(): string;
+    getDisplayName(): string;
+    get(key: string, splitIndex?: number, fallback?: string): string;
+    remove(key: string): boolean;
+    set(key: string, value: string, splitIndex?: number): void;
+    private getNextLine;
+    private deEscape;
+    private escape;
+    copy(): VCard;
+    /**
+     * Apply all data from an other vcard to this object
+     * @param other
+     */
+    apply(other: VCard): void;
+    getType(): number;
+}

package/lib/util/color-helper.d.ts

@@ -0,0 +1,25 @@
+export declare class ColorHelper {
+    static cssColorToRgb(color: string): number[];
+    /**
+     * returns the estimated color brightness for a css color based on a pereceived brightness factor
+     * Value between [0,1] and -1 if the css string was not readable
+     * @param {string} color
+     * @returns {number}
+     */
+    static getColorBrightness(color: string): number;
+    private static getRatio;
+    /**
+     * returns 0 (black) or 1 (white)
+     * @param color
+     */
+    static getPreferredColor(color: string): PreferredColor;
+    static rgbToHex(rgb: number[]): string;
+    static componentToHex(c: number): string;
+    static rgbToHsl(rgb: number[]): number[];
+    private static hue2rgb;
+    static hslToRgb(hsl: number[]): number[];
+}
+export declare enum PreferredColor {
+    Black = 0,
+    White = 1
+}

package/lib/util/duration-helper.d.ts

@@ -0,0 +1,14 @@
+export declare enum DurationFormat {
+    /**
+     * format with colon, i.e. H:MM:SS
+     */
+    Colon = "colon",
+    /**
+     * format with Hh Mm Ss
+     */
+    Hms = "hms"
+}
+export declare class DurationHelper {
+    static getDurationInSeconds(value: string): number;
+    static getDurationFormatted(duration: string, format?: DurationFormat): string;
+}

package/lib/util/functions.d.ts

@@ -0,0 +1,4 @@
+export declare function notNull<T>(value: T): boolean;
+export declare function isTrue(value: boolean): boolean;
+export declare function microTick(): Promise<void>;
+export declare function macroTick(): Promise<void>;

package/lib/util/helper.d.ts

@@ -0,0 +1,20 @@
+export declare class Helper {
+    static deepCopy(data: any): any;
+    static deepCopyArray(data: any[]): any[];
+    /**
+     * Returns true if both objects have the same values stored
+     * will not work for classes including methods or similar dynamic data
+     * @param object1
+     * @param object2
+     * @returns {boolean}
+     */
+    static objectEquals(object1: any, object2: any): boolean;
+    /**
+     * get data from an object based on a dotted path
+     * also supports arrays like "array.0.key"
+     * @param nested the object to return the data from
+     * @param path the path of the field location in dotted notation
+     */
+    static getDotPathFromNestedObject(nested: any, path: string): any;
+    static filterObjectPropertyNested(obj: any, property: string[]): any;
+}

package/lib/util/isNumeric.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copy paste from rxjs/util/isNumeric since importing it from there will trigger a warning about
+ * CommonJS or AMD dependencies and indeed increase the bundle size a bit.
+ */
+export declare function isNumeric(val: any): val is number | string;

package/lib/util/rest-helper.d.ts

@@ -0,0 +1,10 @@
+import { Node } from 'ngx-edu-sharing-api';
+/**
+ * Different helper functions, may be used globally
+ */
+export declare class RestHelper {
+    protected static SPACES_STORE_REF: string;
+    static getName(node: Node): string;
+    static getTitle(node: Node): string;
+    static getTitleFromProperties(properties: any): string;
+}

package/lib/util/ui-animation.d.ts

@@ -0,0 +1,39 @@
+export declare class UIAnimation {
+    static ANIMATION_TIME_FAST: number;
+    static ANIMATION_TIME_NORMAL: number;
+    static ANIMATION_TIME_SLOW: number;
+    static fade(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    static fromBottom(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    static fromLeft(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    static fromRight(time?: number | string): import("@angular/animations").AnimationTransitionMetadata[];
+    static infobarBottom(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    /**
+     * Useful animation for opening any overflow menus
+     * @param time
+     * @returns {AnimationStateTransitionMetadata[]}
+     */
+    static openOverlay(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    /**
+     * Useful animation for opening any overflow menus - inverted (from bottom to top)
+     * @param time
+     * @returns {AnimationStateTransitionMetadata[]}
+     */
+    static openOverlayBottom(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    /**
+     * Useful animation to switch different content insides a dialog (navigating between contents)
+     * @param time
+     * @returns {AnimationStateTransitionMetadata[]}
+     */
+    static switchDialog(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+    /**
+     * Useful animation to switch different content insides a dialog (navigating between contents)
+     * This is a special variant which does work without ngIf fields, it will remove display states
+     */
+    static switchDialogBoolean(time?: number): (import("@angular/animations").AnimationTransitionMetadata | import("@angular/animations").AnimationStateMetadata)[];
+    /**
+     * Useful animation for showing any modal cards
+     * @param time
+     * @returns {AnimationStateTransitionMetadata[]}
+     */
+    static cardAnimation(time?: number): import("@angular/animations").AnimationTransitionMetadata[];
+}

package/lib/util/ui-constants.d.ts

@@ -0,0 +1,18 @@
+export declare class UIConstants {
+    static ROUTER_PREFIX: string;
+    static MOBILE_WIDTH: number;
+    static MOBILE_HEIGHT: number;
+    static MOBILE_HEIGHT_WITH_KEYBOARD: number;
+    static MOBILE_STAGE: number;
+    static MOBILE_TAB_SWITCH_WIDTH: number;
+    static MEDIA_QUERY_MIN_WIDTH: string;
+    static MEDIA_QUERY_MAX_WIDTH: string;
+    static MEDIA_QUERY_MIN_HEIGHT: string;
+    static MEDIA_QUERY_MAX_HEIGHT: string;
+    static QUERY_PARAM_LIST_VIEW_TYPE: string;
+}
+export declare enum OPEN_URL_MODE {
+    Current = 0,
+    Blank = 1,
+    BlankSystemBrowser = 2
+}

package/{src/module.ts → module.d.ts}

@@ -1,7 +1,3 @@
-/*
- * Public API Surface of edu-sharing-ui
- */
-
 export * from './lib/edu-sharing-ui.module';
 export * from './lib/edu-sharing-ui-configuration';
 export * from './lib/translations/fallback-translation-handler';

package/package.json

@@ -1,19 +1,33 @@
 {
   "name": "ngx-edu-sharing-ui",
-  "version": "0.7.0",
+  "version": "9.0.1",
   "license": "GNU GPL v2",
   "description": "Angular components for Edu-Sharing UX parts",
   "peerDependencies": {
-    "@angular/cdk": "~13.3.9",
-    "@angular/common": "^13.3.0",
-    "@angular/core": "^13.3.0",
-    "@angular/material": "13.3.9",
+    "@angular/cdk": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
+    "@angular/common": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
+    "@angular/core": "^^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
+    "@angular/material": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
     "material-design-icons": "^3.0.1",
-    "@ngx-translate/core": "^14.0.0",
+    "@ngx-translate/core": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
     "angular-material-css-vars": "^3.0.0",
-    "rxjs": "^6.6.7"
+    "rxjs": "^6.6.7 || ^7.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"
-  }
-}
+  },
+  "module": "fesm2022/ngx-edu-sharing-ui.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/ngx-edu-sharing-ui.mjs",
+      "esm": "./esm2022/ngx-edu-sharing-ui.mjs",
+      "default": "./fesm2022/ngx-edu-sharing-ui.mjs"
+    }
+  },
+  "sideEffects": false
+}

package/.browserslistrc

@@ -1,16 +0,0 @@
-# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
-# For additional information regarding the format and rule options, please see:
-# https://github.com/browserslist/browserslist#queries
-
-# For the full list of supported browsers by the Angular framework, please see:
-# https://angular.io/guide/browser-support
-
-# You can see what browsers were selected by your queries by running:
-#   npx browserslist
-
-last 1 Chrome version
-last 1 Firefox version
-last 2 Edge major versions
-last 2 Safari major versions
-last 2 iOS major versions
-Firefox ESR

package/.eslintrc.json

@@ -1,44 +0,0 @@
-{
-  "extends": "../../.eslintrc.json",
-  "ignorePatterns": [
-    "!**/*"
-  ],
-  "overrides": [
-    {
-      "files": [
-        "*.ts"
-      ],
-      "parserOptions": {
-        "project": [
-          "projects/edu-sharing-ui/tsconfig.lib.json",
-          "projects/edu-sharing-ui/tsconfig.spec.json"
-        ],
-        "createDefaultProgram": true
-      },
-      "rules": {
-        "@angular-eslint/directive-selector": [
-          "error",
-          {
-            "type": "attribute",
-            "prefix": "lib",
-            "style": "camelCase"
-          }
-        ],
-        "@angular-eslint/component-selector": [
-          "error",
-          {
-            "type": "element",
-            "prefix": "lib",
-            "style": "kebab-case"
-          }
-        ]
-      }
-    },
-    {
-      "files": [
-        "*.html"
-      ],
-      "rules": {}
-    }
-  ]
-}

package/karma.conf.js

@@ -1,42 +0,0 @@
-// Karma configuration file, see link for more information
-// https://karma-runner.github.io/1.0/config/configuration-file.html
-
-module.exports = function (config) {
-    config.set({
-        basePath: '',
-        frameworks: ['jasmine', '@angular-devkit/build-angular'],
-        plugins: [
-            require('karma-jasmine'),
-            require('karma-chrome-launcher'),
-            require('karma-jasmine-html-reporter'),
-            require('karma-coverage'),
-            require('@angular-devkit/build-angular/plugins/karma'),
-        ],
-        client: {
-            jasmine: {
-                // you can add configuration options for Jasmine here
-                // the possible options are listed at https://jasmine.github.io/api/edge/Configuration.html
-                // for example, you can disable the random execution with `random: false`
-                // or set a specific seed with `seed: 4321`
-            },
-            clearContext: false, // leave Jasmine Spec Runner output visible in browser
-        },
-        jasmineHtmlReporter: {
-            suppressAll: true, // removes the duplicated traces
-        },
-        coverageReporter: {
-            dir: require('path').join(__dirname, '../../coverage/edu-sharing-ui'),
-            subdir: '.',
-            reporters: [{ type: 'html' }, { type: 'text-summary' }],
-        },
-        reporters: ['progress', 'kjhtml'],
-        browsers: ['Chrome'],
-        customLaunchers: {
-            ChromeHeadlessCI: {
-                base: 'ChromeHeadless',
-                flags: ['--no-sandbox'],
-            },
-        },
-        restartOnFileChange: true,
-    });
-};

package/ng-package.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/edu-sharing-ui",
-  "assets": [
-    "assets/**"
-  ],
-  "lib": {
-    "entryFile": "src/module.ts"
-  }
-}