@yuuvis/client-core 2.20.0 → 3.0.0-beta.20.0

package/lib/service/upload/upload.service.d.ts

@@ -1,160 +0,0 @@
-import { Observable } from 'rxjs';
-import { FileUploadOptions } from '../../model/file-upload-options.model';
-import { ProgressStatus } from './upload.interface';
-import * as i0 from "@angular/core";
-/**
- * Service for providing upload of different object types into a client.
- */
-export declare class UploadService {
-    #private;
-    status$: Observable<ProgressStatus>;
-    uploadStatus$: Observable<boolean | null>;
-    /**
-     * Upload a file.
-     * @param url The URL to upload the file to
-     * @param file The file to be uploaded
-     * @param label A label that will show up in the upload overlay dialog while uploading
-     *
-     * @deprecated use uploadFile instead. `label`, `silent` as well as `scope` can be provided through `options`.
-     */
-    upload(url: string, file: File, label?: string, silent?: boolean): Observable<any>;
-    /**
-     * Uploads a single file to the specified URL using the structured `FileUploadOptions` object.
-     *
-     * This is the preferred alternative to the legacy `upload()` method. It accepts a typed
-     * options object instead of individual parameters, which makes it easier to pass optional
-     * settings such as `silent` mode and `scope` without relying on positional arguments.
-     *
-     * **Behavior:**
-     * - If `options.silent` is `false` (default), the upload appears in the upload overlay dialog
-     *   and progress is tracked via `status$`
-     * - If `options.silent` is `true`, the upload runs quietly in the background with no UI feedback
-     * - `options.label` is shown in the overlay dialog during upload; falls back to `file.name` if omitted
-     * - `options.scope` tags the upload with a named scope, enabling an `UploadProgressComponent`
-     *   configured with the same scope to display only the uploads relevant to its section of the UI
-     *
-     * @param url - The backend URL to POST the file to
-     * @param file - The `File` object to be uploaded
-     * @param options - Upload configuration: label, silent mode, and optional scope
-     * @returns An `Observable` that emits the server response on completion
-     *
-     * @example
-     * ```typescript
-     * // Standard upload with progress indicator
-     * this.uploadService.uploadFile(url, file, { label: 'Uploading contract.pdf' }).subscribe();
-     *
-     * // Silent upload (no UI, runs in background)
-     * this.uploadService.uploadFile(url, file, { label: 'document.pdf', silent: true }).subscribe();
-     *
-     * // Scoped upload — only the UploadProgressComponent with scope 'profile-editor' will show this
-     * this.uploadService.uploadFile(url, file, { label: 'photo.jpg', scope: 'profile-editor' }).subscribe();
-     * ```
-     */
-    uploadFile(url: string, file: File, options: FileUploadOptions): Observable<unknown>;
-    /**
-     * Upload files using multipart upload.
-     * @param url The URL to upload the files to
-     * @param files The files to be uploaded
-     * @param data Data to be send along with the files
-     * @param label A label that will show up in the upload overlay dialog while uploading
-     *
-     * @deprecated Use multipartUpload(url, files, options, data) instead. Provide scope through options.
-     */
-    uploadMultipart(url: string, files: File[], data?: any, label?: string, silent?: boolean): Observable<any>;
-    /**
-     * Uploads multiple files to the specified URL using a multipart/form-data request.
-     *
-     * This is the preferred method for multi-file uploads. It accepts a typed `FileUploadOptions`
-     * object for configuration, making it easier to pass `scope` and other options compared
-     * to the legacy `uploadMultipart()` overload.
-     *
-     * **Behavior:**
-     * - All files are bundled into a single `FormData` payload under the `files` field
-     * - Optional `data` is appended as a JSON blob under the `data` field
-     * - If `options.silent` is `false` (default), upload progress is shown in the overlay dialog
-     * - If `options.silent` is `true`, the upload runs in the background with no UI feedback
-     * - `options.scope` tags the upload with a named scope, enabling an `UploadProgressComponent`
-     *   configured with the same scope to display only the uploads relevant to its section of the UI
-     *
-     * @param url - The backend URL to POST the multipart request to
-     * @param files - Array of `File` objects to upload
-     * @param options - Upload configuration: label (required), silent mode, and optional scope
-     * @param data - Optional metadata object to send alongside the files (serialized as JSON)
-     * @returns An `Observable` that emits the server response on completion
-     *
-     * @example
-     * ```typescript
-     * // Upload files with a visible progress indicator
-     * this.uploadService.multipartUpload(url, files, { label: 'Uploading 3 files' }).subscribe();
-     *
-     * // Upload files with additional metadata
-     * this.uploadService
-     *   .multipartUpload(url, files, { label: 'Batch upload' }, { folderId: 'abc123' })
-     *   .subscribe();
-     *
-     * // Scoped upload — only the UploadProgressComponent with scope 'mail-editor' will show this
-     * this.uploadService
-     *   .multipartUpload(url, files, { label: 'attachments', scope: 'mail-editor' })
-     *   .subscribe();
-     * ```
-     */
-    multipartUpload(url: string, files: File[], options: FileUploadOptions, data?: unknown): Observable<unknown>;
-    /**
-     * Creates a document on the server by sending structured metadata without a file attachment.
-     *
-     * Unlike `uploadFile()` and `multipartUpload()`, this method does not attach any file content.
-     * It is intended for creating document objects from metadata alone — for example, creating
-     * a folder, a placeholder record, or a document entry where the content stream will be
-     * provided separately.
-     *
-     * **Behavior:**
-     * - Sends the `data` object as a JSON blob inside a `FormData` payload
-     * - Progress is NOT tracked — this method does not appear in `status$`
-     * - Errors are re-thrown so the caller can handle them via the returned `Observable`
-     *
-     * @param url - The backend URL to POST the document creation request to
-     * @param data - Metadata object describing the document to be created
-     * @returns An `Observable` that emits the created object(s) on success
-     *
-     * @example
-     * ```typescript
-     * const metadata = {
-     *   objectTypeId: 'yuv:document',
-     *   properties: { 'yuv:title': 'My Document' }
-     * };
-     *
-     * this.uploadService.createDocument(url, metadata).subscribe((result) => {
-     *   console.log('Created:', result);
-     * });
-     * ```
-     */
-    createDocument(url: string, data: any): Observable<any>;
-    /**
-     * Cancels one or all active upload requests and removes them from the tracked upload list.
-     *
-     * This method unsubscribes from the underlying HTTP request, effectively aborting the upload,
-     * and removes the corresponding item(s) from the internal status list. The updated status
-     * is then emitted via `status$` so that any subscribed UI components (e.g. the upload overlay)
-     * can reflect the change immediately.
-     *
-     * **Behavior:**
-     * - If `id` is provided, only the matching upload item is cancelled
-     * - If `id` is omitted, **all** active uploads are cancelled at once
-     * - If the provided `id` does not match any active item, the call is a no-op
-     * - After cancellation, the error count on `status$` is recalculated
-     *
-     * @param id - Optional ID of the upload item to cancel. Omit to cancel all active uploads.
-     *
-     * @example
-     * ```typescript
-     * // Cancel a specific upload by ID
-     * this.uploadService.cancelItem(uploadId);
-     *
-     * // Cancel all ongoing uploads (e.g. on component destroy or user confirmation)
-     * this.uploadService.cancelItem();
-     * ```
-     */
-    cancelItem(id?: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<UploadService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<UploadService>;
-}

package/lib/service/user/user-storage.service.d.ts

@@ -1,18 +0,0 @@
-import { Observable } from 'rxjs';
-import * as i0 from "@angular/core";
-/**
- * Service providing user related remote storage. This service is used load and
- * store user related data from any device.
- */
-export declare class UserStorageService {
-    #private;
-    /**
-     *
-     * @param section section key for
-     * @param value  value to be stored
-     */
-    getItem(section: string): Observable<Record<string, any> | undefined>;
-    setItem(section: string, data: Record<string, any>): Observable<any>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<UserStorageService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<UserStorageService>;
-}

package/lib/service/user/user.providers.d.ts

@@ -1,4 +0,0 @@
-import { InjectionToken, Provider } from "@angular/core";
-import { YuvUser } from "../../model/yuv-user.model";
-export declare const YUV_USER: InjectionToken<YuvUser | undefined>;
-export declare const provideUser: (user: YuvUser) => Provider;

package/lib/service/user/user.service.d.ts

@@ -1,67 +0,0 @@
-import { TranslateService } from '@ngx-translate/core';
-import { Observable } from 'rxjs';
-import { UserSettings, YuvUser } from '../../model/yuv-user.model';
-import { BackendService } from '../backend/backend.service';
-import { ConfigService } from '../config/config.service';
-import { EventService } from '../event/event.service';
-import { Logger } from '../logger/logger.service';
-import { StoredObjectConfig } from '../object-config/object-config.interface';
-import { UserPermissions } from '../system/system.interface';
-import { SystemService } from '../system/system.service';
-import * as i0 from "@angular/core";
-/**
- * Service providing user account configurations.
- */
-export declare class UserService {
-    #private;
-    private backend;
-    private translate;
-    private logger;
-    private system;
-    private eventService;
-    private config;
-    user$: Observable<YuvUser | undefined>;
-    globalSettings: Map<any, any>;
-    userPermissions?: UserPermissions;
-    /**
-     * @ignore
-     */
-    constructor(backend: BackendService, translate: TranslateService, logger: Logger, system: SystemService, eventService: EventService, config: ConfigService);
-    private getUiDirection;
-    /**
-     * Set a new current user
-     * @param user The user to be set as current user
-     */
-    setCurrentUser(user: YuvUser): void;
-    getCurrentUser(): YuvUser;
-    get hasAdminRole(): boolean;
-    get hasSystemRole(): boolean;
-    get hasAdministrationRoles(): boolean;
-    get hasManageSettingsRole(): boolean;
-    get isAdvancedUser(): boolean;
-    get isRetentionManager(): boolean;
-    canCreateObjects: boolean;
-    /**
-     * Change the users client locale
-     * @param iso ISO locale string to be set as new client locale
-     */
-    changeClientLocale(iso: string, persist?: boolean): void;
-    saveUserSettings(settings: Partial<UserSettings>): Observable<any>;
-    fetchUserSettings(): Observable<UserSettings>;
-    private setUserPermissions;
-    private mapPermissions;
-    /**
-     * Search for a user based on a search term
-     * @param term Search term
-     * @param excludeMe whether or not to exclude myself from the result list
-     * @param roles narrow down the search results by certain roles
-     */
-    queryUser(term: string, excludeMe?: boolean, roles?: string[]): Observable<YuvUser[]>;
-    getUserById(id: string): Observable<YuvUser>;
-    logout(redirRoute?: string): void;
-    getSettings(section: string): Observable<any>;
-    saveObjectConfig(objectConfigs: StoredObjectConfig): Observable<any>;
-    loadObjectConfig(): Observable<StoredObjectConfig | undefined>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<UserService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<UserService>;
-}

package/lib/util/utils.d.ts

@@ -1,123 +0,0 @@
-import { FormattedMailTo, Sort } from './utils.helper.enum';
-import { RangeValue } from '../model/range-value.interface';
-export declare class Utils {
-    static readonly DEFAULT_TIME_OFFSET_V2: number;
-    static optionsToURLParams(options: Record<string, any>): string;
-    /**
-     * Get all focusable child elements of a host element.
-     * @param host The host/parent element
-     * @returns Array of focusable child elements
-     */
-    static getFocusableChildren(host: HTMLElement): Element[];
-    static hasProperty(o: unknown, property: string): boolean;
-    static patternToRegExp(pattern: string): RegExp;
-    /**
-     * Utility method for adding parameters to a given URI.
-     *
-     * @param uri The uri string to attach the parameters to
-     * @param params The object containing parameters to be appended
-     * @returns the given uri extended by the given parameters + remove empty parameters
-     */
-    static buildUri(uri: string, params: any): string;
-    static formatMailTo(value: FormattedMailTo, isEmail: boolean): FormattedMailTo;
-    /**
-     * Creates a unique identifier.
-     * @returns A Universally Unique Identifier
-     */
-    static uuid(): string;
-    /**
-     * Encode a filename safe for sending chars beyond ASCII-7bit using quoted printable encoding.
-     *
-     * @param filename The file name
-     * @returns The quoted printable filename
-     */
-    static encodeFileName(filename: string): string;
-    /**
-     *
-     * @param boolean s
-     * @return string
-     */
-    private static _p8;
-    /**
-     * Converts a javascript text to the utf-8 converted variant.
-     * See [unicode]{@link http://thlist.onlinehome.de/thomas_homepage/unicode/UTF-8%20Konvertierung%20mittels%20JavaScript.htm} for reference
-     *
-     * @param rawinput The input string
-     * @returns The utf-8 converted string
-     */
-    private static encodeToUtf8;
-    /**
-     * See [quoted-printable]{@link https://github.com/mathiasbynens/quoted-printable/blob/master/quoted-printable.js}
-     **/
-    private static quotedPrintable;
-    /**
-     * Encode symbols that are definitely unsafe (i.e. unsafe in any context). The regular expression describes these unsafe symbols.
-     *
-     * @param rawinput Input string to be encoded
-     * @returns The encoded string
-     */
-    private static encodeToQuotedPrintable;
-    /**
-     * Sorts An Array of Object by given key
-     * See [ng-packagr issues 696]{@link https://github.com/dherges/ng-packagr/issues/696}
-     *
-     * @param key
-     * @param order
-     * @param locales
-     * @param options
-     * @returns (a: any, b: any) => number
-     */
-    static sortValues(key?: string, order?: Sort, locales?: string | string[], options?: Intl.CollatorOptions): (a: any, b: any) => number;
-    /**
-     * [ng-packagr issues 696]{@link https://github.com/dherges/ng-packagr/issues/696}
-     *
-     * @param object
-     * @param string key
-     * @returns any
-     */
-    static getProperty(object: any, key?: string): any;
-    /**
-     * @param object
-     * @param key
-     * @param value
-     */
-    static setProperty(object: any, key: string | undefined, value: any): any;
-    /**
-     * Use on Observable.catch or Observable.subscribe to return empty value
-     * [ng-packagr issues 696]{@link https://github.com/dherges/ng-packagr/issues/696}
-     *
-     * @param (error) => any callback
-     * @returns (error) => Observable<never>
-     */
-    static empty(callback?: (error: any) => any): () => import("rxjs").Observable<never>;
-    static getBaseHref(removeTrailingSlash?: boolean): string;
-    /**
-     * Truncate a string (first argument) if it is longer than the given maximum string length (second argument).
-     * Return the truncated string with a ... ending or whats provided.
-     *
-     * @param string str
-     * @param number num
-     */
-    static truncateString(str: string, num: number, ending?: string): string;
-    /**
-     * Get the TimeZone Offsest as minutes
-     */
-    static getTimezoneOffset(): number;
-    /**
-     * Transform to date with yyyy-mm-dd format
-     */
-    static transformDate(v: Date | string): string;
-    static isEdge(): boolean;
-    static isFirefox(): boolean;
-    static isSafari(): boolean;
-    static isEmpty(obj: any): boolean;
-    static isEmptyOrFalse(val: any): boolean;
-    static escapeHtml(str: string): string;
-    static arrayToObject<T>(arr?: any[], keyProperty?: string | ((o: any) => string), valueProperty?: string | ((o: any) => any)): {
-        [key: string]: T;
-    };
-    static downloadBlob(content: any, mimeType: string, filename: string): void;
-    static isValidDate(value: any): value is Date;
-    static getDateFrom(value?: Date | string | null): Date | undefined;
-    static getDateRangeFrom(dateRange: RangeValue<Date | string>): RangeValue<Date> | undefined;
-}

package/lib/util/utils.helper.enum.d.ts

@@ -1,13 +0,0 @@
-export declare enum Sort {
-    ASC = "asc",
-    DESC = "desc"
-}
-export declare enum ClassificationPrefix {
-    EMAIL = "mailto:",
-    EMAIL_ICON = "envelope",
-    PHONE = "tel:",
-    PHONE_ICON = "phone",
-    URL = "",
-    URL_ICON = "globe"
-}
-export type FormattedMailTo = string | string[];