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

package/lib/service/dms/dms.service.d.ts

@@ -1,207 +0,0 @@
-import { Observable } from 'rxjs';
-import { DmsObjectTag } from '../../model/dms-object.interface';
-import { DmsObject } from '../../model/dms-object.model';
-import { FileUploadOptions } from '../../model/file-upload-options.model';
-import { HttpOptions } from '../backend/backend.interface';
-import { SearchResponse, SearchResult } from '../search/search.service.interface';
-import { CoreApiResponse, ObjectCopyOptions, ObjectDeleteOptions, ObjectDeleteResult, ObjectMoveOptions, ObjectOptions } from './dms.service.interface';
-import * as i0 from "@angular/core";
-/**
- * Service for working with dms objects: create them, delete, etc.
- */
-export declare class DmsService {
-    #private;
-    /**
-     * Create new dms object(s). Providing an array of files here instead of one will create
-     * a new dms object for every file. In this case indexdata will shared across all files.
-     * @param objectTypeId The ID of the object type to be created
-     * @param indexdata Indexdata for the new object(s)
-     * @param files File(s) to create dms objects content(s) with
-     * @param label A label that will show up in the upload overlay dialog while uploading
-     *
-     * @returns Array of IDs of the objects that have been created
-     */
-    createDmsObject(objectTypeId: string, indexdata: any, files: File[], label?: string, silent?: boolean, options?: ObjectOptions): Observable<string[]>;
-    /**
-     * Delete a dms object.
-     * @param id ID of the object to be deleted
-     */
-    deleteDmsObject(id: string, silent?: boolean): Observable<any>;
-    /**
-     * Restore older version of a dms object.
-     * @param id ID of the object to be restored
-     * @param version version of the object to be restored
-     */
-    restoreDmsObject(id: string, version: number, silent?: boolean): Observable<any>;
-    /**
-     * Upload (add/replace) content to a dms object.
-     * @param objectId ID of the dms object 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 uploadFileContent instead. Provide label and silent through `options`
-     */
-    uploadContent(objectId: string, file: File, label?: string, silent?: boolean): Observable<any>;
-    /**
-     * Uploads a file as the content of an existing DMS object, replacing or setting its content stream.
-     *
-     * This is the preferred alternative to the legacy `uploadContent()` method. It accepts a typed
-     * `FileUploadOptions` object instead of individual parameters, which enables full control over
-     * the upload label, silent mode, and scope-based progress visibility.
-     *
-     * After a successful upload, a `DMS_OBJECT_UPDATED` event is triggered automatically so that
-     * any subscribed parts of the application can react to the change (e.g. refreshing a preview).
-     *
-     * **Behavior:**
-     * - Targets the content endpoint of the given DMS object: `/dms/objects/{objectId}/contents/file`
-     * - `options.label` is shown in the upload progress indicator; falls back to `file.name` if omitted
-     * - If `options.silent` is `true`, the upload runs in the background with no UI feedback
-     *   and no `DMS_OBJECT_UPDATED` event is emitted
-     * - `options.scope` tags the upload so that only the `UploadProgressComponent` instance
-     *   configured with the same scope will display progress for this upload
-     *
-     * @param objectId - ID of the DMS object whose content should be uploaded or replaced
-     * @param file - The `File` object to upload as the new content stream
-     * @param options - Upload configuration: label, silent mode, and optional scope
-     * @returns An `Observable` that emits the updated DMS object on completion
-     *
-     * @example
-     * ```typescript
-     * // Replace content with a visible progress indicator
-     * this.dmsService.uploadFileContent(objectId, file, { label: 'Uploading contract.pdf' }).subscribe();
-     *
-     * // Silent replacement (no UI feedback, no event emitted)
-     * this.dmsService.uploadFileContent(objectId, file, { label: 'report.pdf', silent: true }).subscribe();
-     *
-     * // Scoped upload — only UploadProgressComponent with scope 'detail-panel' will show this
-     * this.dmsService
-     *   .uploadFileContent(objectId, file, { label: 'photo.jpg', scope: 'detail-panel' })
-     *   .subscribe();
-     * ```
-     */
-    uploadFileContent(objectId: string, file: File, options: FileUploadOptions): Observable<unknown>;
-    /**
-     * Path of dms object content file.
-     * @param objectId ID of the dms object
-     * @param version version number of the dms object
-     */
-    getContentPath(objectId: string, version?: number): string;
-    /**
-     * Original API Path of dms object content file.
-     * @param objectId ID of the dms object
-     * @param version version number of the dms object
-     * @param rendition should return rendition path of the dms object
-     */
-    getFullContentPath(objectId: string, version?: number, rendition?: boolean): string;
-    getSlideURI(objectId: string, mimeType?: string): string | undefined;
-    /**
-     * Downloads the content of dms objects.
-     *
-     * @param DmsObject[] dmsObjects Array of dms objects to be downloaded
-     * @param withVersion should download specific version of the object
-     */
-    downloadContent(objects: DmsObject[], withVersion?: boolean): void;
-    /**
-     * Fetch a dms object.
-     * @param id ID of the object to be retrieved
-     * @param version Desired version of the object
-     */
-    getDmsObject(id: string, version?: number, silent?: boolean, requestOptions?: HttpOptions): Observable<DmsObject>;
-    /**
-     * Get tags of a dms object.
-     * @param objectData  Data field of the dms object
-     */
-    getDmsObjectTags(objectData: Record<string, unknown>): DmsObjectTag[];
-    /**
-     * Updates a tag on a dms object.
-     * @param id The ID of the object
-     * @param tag The tag to be updated
-     * @param value The tags new value
-     */
-    setDmsObjectTag(id: string, tag: string, value: any, silent?: boolean): Observable<any>;
-    /**
-     * Deletes a tag from a dms object.
-     * @param id The ID of the object
-     * @param tag The tag to be deleted
-     */
-    deleteDmsObjectTag(id: string, tag: string, silent?: boolean): Observable<any>;
-    /**
-     * Update indexdata of a dms object.
-     * @param id ID of the object to apply the data to
-     * @param data Indexdata to be applied
-     * @param silent flag to trigger DMS_OBJECT_UPDATED event
-     */
-    updateDmsObject(id: string, data: any, silent?: boolean, options?: ObjectOptions): Observable<DmsObject>;
-    /**
-     * Updates given objects.
-     * @param objects the objects to updated
-     */
-    updateDmsObjects(objects: {
-        id: string;
-        data: {
-            [key: string]: any;
-        };
-    }[], silent?: boolean, options?: ObjectOptions): Observable<DmsObject[]>;
-    /**
-     * Updates a tag on a dms object.
-     * @param ids List of IDs of objects
-     * @param tag The tag to be updated
-     * @param value The tags new value
-     */
-    updateDmsObjectsTag(ids: string[], tag: string, value: any, silent?: boolean): Observable<any>;
-    /**
-     * Moves given objects to a different folder.
-     * @param folderId the id of the new parent folder
-     * @param objects objects to be moved
-     * @param options options for the move operation
-     */
-    moveDmsObjects(targetFolderId: string | null, objects: DmsObject[], options?: ObjectMoveOptions): Observable<any>;
-    /**
-     * Copy given objects to a different folder. The objects will be copied with their indexdata referencing
-     * the existing content of the source object.
-     * @param targetFolderId The ID of the target folder
-     * @param objects The objects to be copied
-     * @param options options for the copy operation
-     */
-    copyDmsObjects(targetFolderId: string | null, objects: DmsObject[], options?: ObjectCopyOptions): Observable<CoreApiResponse>;
-    /**
-     * Get a bunch of dms objects.
-     * @param ids List of IDs of objects to be retrieved
-     */
-    getDmsObjects(ids: string[], silent?: boolean): Observable<DmsObject[]>;
-    /**
-     * Delete a bunch of dms objects.
-     * @param ids List of IDs of objects to be deleted
-     * @param options Options for the delete operation
-     * @returns Array of delete results.
-     */
-    deleteDmsObjects(objects: string[] | {
-        id: string;
-        subject: string;
-    }[], options?: ObjectDeleteOptions): Observable<ObjectDeleteResult[]>;
-    /**
-     * Fetch a dms object versions.
-     * @param id ID of the object to be retrieved
-     */
-    getDmsObjectVersions(id: string): Observable<DmsObject[]>;
-    getDmsObjectVersion(id: string, version: number): Observable<DmsObject>;
-    coreApiResponseToDmsObject(res: CoreApiResponse): DmsObject;
-    /**
-     * Transforms a plain data object to a DmsObject.
-     * @param data The plain data object
-     * @returns DmsObject
-     */
-    toDmsObject(data: Record<string, unknown>): DmsObject;
-    batchUpdateTag(ids: string[], tag: string, value: any): Observable<any[]>;
-    batchDeleteTag(ids: string[], tag: string): Observable<any[]>;
-    batchDelete(ids: string[]): Observable<any[]>;
-    batchGet(ids: string[]): Observable<any[]>;
-    /**
-     * Map search result from the backend to applications SearchResult object
-     * @param searchResponse The backend response
-     */
-    toSearchResult(searchResponse: SearchResponse): SearchResult;
-    private triggerEvent;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DmsService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DmsService>;
-}

package/lib/service/dms/dms.service.interface.d.ts

@@ -1,60 +0,0 @@
-export interface ObjectOptions {
-    waitForSearchConsistency?: boolean;
-    scope?: string;
-}
-export interface ObjectDeleteOptions extends ObjectOptions {
-    silent?: boolean;
-    greedy?: boolean;
-}
-export interface ObjectDeleteResult {
-    id: string;
-    properties?: {
-        [key: string]: {
-            value: any;
-        };
-    };
-    _error?: ObjectDeleteError;
-}
-export interface ObjectDeleteError {
-    status: number;
-    message: string;
-}
-export interface ObjectMoveOptions extends ObjectOptions {
-    silent?: boolean;
-}
-export interface ObjectCopyOptions extends ObjectOptions {
-}
-export interface CoreApiObject {
-    properties: Record<string, CoreApiObjectProperty>;
-    contentStreams?: Partial<ContentStream>[];
-}
-export interface CoreApiObjectProperty {
-    value: unknown;
-}
-export interface ContentStream {
-    contentStreamId: string;
-    repositoryId: string;
-    digest: string;
-    fileName: string;
-    size: number;
-    archivePath?: string;
-    range?: string;
-    mimeType: string;
-}
-export interface CoreApiBatchResponse {
-    hasMoreItems: boolean;
-    numItems: number;
-    objects: CoreApiResponse[];
-    totalNumItems: number;
-}
-export interface CoreApiResponse {
-    properties: Record<string, CoreApiObjectProperty>;
-    contentStreams?: ContentStream[];
-    options: {
-        'system:response': {
-            httpStatusCode: number;
-            serviceErrorCode?: number;
-            message: string;
-        };
-    };
-}

package/lib/service/event/custom.events.token.d.ts

@@ -1,3 +0,0 @@
-import { InjectionToken } from '@angular/core';
-export declare const CUSTOM_EVENTS: InjectionToken<string[]>;
-export declare const CUSTOM_EVENTS_TRUSTED_ORIGINS: InjectionToken<string[]>;

package/lib/service/event/event.interface.d.ts

@@ -1,36 +0,0 @@
-/**
- * Triggerable and Subscribable events
- * 1 & T creates an intersection of the literal type 1 and type T, this results in never since nothing can be both 1 and string except for any.
- * 0 dose not extends never or 1, so if T is any, the condition resolves to true.
- */
-export type IsAny<T> = 0 extends 1 & T ? true : false;
-export interface YuvEvent<D = any> {
-    /**
-     * type
-     */
-    type: string;
-    /**
-     * data to be passed along with the event if T is 'any' data is optional
-     */
-    data: IsAny<D> extends true ? D | undefined : D;
-}
-/**
- * Mandatory Custom event prefix for all custom YUV events
- */
-export declare const CUSTOM_YUV_EVENT_PREFIX = "yuv.";
-/**
- * Message event interface for postMessage events
- */
-export interface YuvMessage {
-    type: string;
-    data: any;
-    timestamp: number;
-    source: string;
-}
-/**
- * Generic call-signature for triggering events.
- * - If `T` is `string`, the `type` parameter will be that string literal type.
- * - If `T` is `any`, the `data` parameter will be optional.
- * - Otherwise `data` is required.
- */
-export type Trigger = <T = any>(type: T extends string ? T : string, ...data: IsAny<T> extends true ? [data?: T] : [data: T]) => void;

package/lib/service/event/event.service.d.ts

@@ -1,30 +0,0 @@
-import { Observable } from 'rxjs';
-import { IsAny, YuvEvent } from './event.interface';
-import * as i0 from "@angular/core";
-/**
- * Service for providing triggered events
- */
-export declare class EventService {
-    #private;
-    event$: Observable<YuvEvent>;
-    constructor();
-    /**
-     * Triggers a postMessage event that will be sent to the yuuvis global event Trigger
-     * @param type Type/key of the event
-     * @param data Data to be sent along with the event
-     */
-    triggerPostMessageEvent(type: string, data?: any): void;
-    /**
-     * Trigger an global event
-     * @param type Type/key of the event
-     * @param data Data to be send along with the event
-     */
-    trigger<T extends string = any, D = any>(type: IsAny<T> extends true ? string : T, ...args: IsAny<D> extends true ? [data?: D] : [data: D]): void;
-    /**
-     * Listen on a triggered event
-     * @param types Type/key of the event
-     */
-    on<T extends string = any, D = any>(...types: (IsAny<T> extends true ? string : T)[]): Observable<YuvEvent<D>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EventService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<EventService>;
-}

package/lib/service/event/events.d.ts

@@ -1,22 +0,0 @@
-import { DmsObject } from '../../model/dms-object.model';
-/**
- * Events emitted by parts of the application
- */
-export declare enum YuvEventType {
-    LOGOUT = "yuv.user.logout",
-    CLIENT_LOCALE_CHANGED = "yuv.user.locale.client.changed",
-    DMS_OBJECT_LOADED = "yuv.dms.object.loaded",
-    DMS_OBJECT_CREATED = "yuv.dms.object.created",
-    DMS_OBJECT_DELETED = "yuv.dms.object.deleted",
-    DMS_OBJECT_UPDATED = "yuv.dms.object.updated",
-    DMS_OBJECT_CONTENT_UPDATED = "yuv.dms.object.content.updated",
-    DMS_OBJECTS_MOVED = "yuv.dms.objects.moved",
-    RELATIONSHIP_CREATED = "yuv.dms.relationship.created",
-    RELATIONSHIP_DELETED = "yuv.dms.relationship.deleted"
-}
-export interface YuvEventDeletedData {
-    id: string;
-    properties: Record<string, unknown>;
-}
-export type YuvEventUpdatedData = DmsObject;
-export type YuvEventCreatedData = string[];

package/lib/service/idm/idm.service.d.ts

@@ -1,43 +0,0 @@
-import { Observable } from 'rxjs';
-import { YuvUser } from '../../model/yuv-user.model';
-import { IdmUserCache, OrganizationSetEntry } from './models';
-import * as i0 from "@angular/core";
-/**
- * Service for managing Identity Management (IDM) operations.
- * Provides functionality for querying users, roles, and organization entities,
- * with built-in caching mechanisms to optimize performance.
- */
-export declare class IdmService {
-    #private;
-    userCache: IdmUserCache;
-    constructor();
-    /**
-     * Queries organization entities (users and/or roles) based on search term.
-     *
-     * @param term - The search term to filter entities
-     * @param targetTypes - Array of entity types to search for ('user', 'role')
-     * @param size - Optional maximum number of results to return
-     * @returns Observable array of organization set entries matching the search criteria
-     */
-    queryOrganizationEntity(term: string, targetTypes: string[], size?: number): Observable<OrganizationSetEntry[]>;
-    /**
-     * Retrieves available roles, optionally filtered by a search term.
-     *
-     * @param role - Optional search term to filter roles by name
-     * @returns Observable array of role objects containing name and description
-     */
-    getRoles(role?: string): Observable<{
-        name: string;
-        description: string;
-    }[]>;
-    /**
-     * Retrieves user information by user ID with automatic caching.
-     * Uses a 1-hour TTL cache to minimize backend requests.
-     *
-     * @param id - The unique identifier of the user
-     * @returns Observable of YuvUser object or null if user is not found
-     */
-    getUserById(id: string): Observable<YuvUser | null>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<IdmService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<IdmService>;
-}

package/lib/service/idm/models/idm-cached-user.model.d.ts

@@ -1,11 +0,0 @@
-import { IdmUserResponse } from './idm-user-response.model';
-/**
- * Represents a cached user entry with expiration timestamp.
- * Used internally by IdmService to manage user data caching.
- */
-export interface IdmCachedUser {
-    /** Timestamp when the cache expires (Date.now() + TTL) */
-    expires: number;
-    /** The cached user data from the IDM API */
-    user: IdmUserResponse;
-}

package/lib/service/idm/models/idm-user-cache.model.d.ts

@@ -1,9 +0,0 @@
-import { IdmCachedUser } from './idm-cached-user.model';
-/**
- * Dictionary/map structure for storing cached user data.
- * Keys are user IDs and values are cached user entries with expiration.
- */
-export interface IdmUserCache {
-    /** Map of user IDs to their cached user data */
-    [userId: string]: IdmCachedUser;
-}

package/lib/service/idm/models/idm-user-response.model.d.ts

@@ -1,24 +0,0 @@
-/**
- * Represents the user data structure returned from the IDM API.
- * Contains all essential user information including authentication and authorization details.
- */
-export interface IdmUserResponse {
-    /** The unique username for login */
-    username: string;
-    /** The unique user identifier */
-    id: string;
-    /** The user's email address */
-    email: string;
-    /** The user's first name */
-    firstname: string;
-    /** The user's last name */
-    lastname: string;
-    /** Whether the user account is enabled/active */
-    enabled: boolean;
-    /** The tenant identifier this user belongs to */
-    tenant: string;
-    /** Array of granted authorities/permissions for the user */
-    authorities: string[];
-    /** The formatted display name for the user */
-    displayName: string;
-}

package/lib/service/idm/models/index.d.ts

@@ -1,4 +0,0 @@
-export * from './organization-set-entry.model';
-export * from './idm-user-cache.model';
-export * from './idm-cached-user.model';
-export * from './idm-user-response.model';

package/lib/service/idm/models/organization-set-entry.model.d.ts

@@ -1,12 +0,0 @@
-/**
- * Represents an entry in the organization set, which can be either a user or a role.
- * Used in search results and organization entity queries.
- */
-export interface OrganizationSetEntry {
-    /** The unique identifier of the user or role */
-    id: string;
-    /** The display title/name for the entry */
-    title: string;
-    /** The type of organization entity */
-    type: 'user' | 'role';
-}

package/lib/service/logger/logger.interface.d.ts

@@ -1,10 +0,0 @@
-/**
- * Interface providing a default logger, that is used for the Dependency-Injection (DI) token.
- */
-export interface ILogger {
-    debug(...args: any[]): void;
-    error(...args: any[]): void;
-    info(...args: any[]): void;
-    log(...args: any[]): void;
-    warn(...args: any[]): void;
-}

package/lib/service/logger/logger.service.d.ts

@@ -1,20 +0,0 @@
-import { ConfigService } from '../config/config.service';
-import { ILogger } from './logger.interface';
-import * as i0 from "@angular/core";
-/**
- * @ignore
- */
-export declare class Logger implements ILogger {
-    private config;
-    constructor(config: ConfigService);
-    private styles;
-    private apply;
-    debug(...args: any[]): void;
-    error(...args: any[]): void;
-    info(...args: any[]): void;
-    log(...args: any[]): void;
-    warn(...args: any[]): void;
-    private shouldLog;
-    static ɵfac: i0.ɵɵFactoryDeclaration<Logger, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<Logger>;
-}

package/lib/service/notification/notification.service.d.ts

@@ -1,71 +0,0 @@
-import * as i0 from "@angular/core";
-/**
- * Shows a message after completing each action.
- */
-export declare class NotificationService {
-    #private;
-    /**
-     * Set to true to suppress any notifications
-     */
-    silent: boolean;
-    /**
-     * Default Notofication Options
-     *
-     */
-    private options;
-    constructor();
-    /**
-     * Show info colored massage (blue)
-     *
-     * @param string title
-     * @param string msg
-     */
-    info(title: string, msg?: string): void;
-    /**
-     * Show success colored massage (green)
-     * @param string title
-     * @param string msg
-     */
-    success(title: string, msg?: string): void;
-    /**
-     * can not be in use
-     *
-     * @param string title
-     * @param string msg
-     */
-    wait(title: string, msg?: string): void;
-    /**
-     * Show error colored massage (red)
-     *
-     * @param string title
-     * @param string msg
-     */
-    error(title: string, msg?: string): void;
-    /**
-     * Show warning colored massage (yellow)
-     *
-     * @param string title
-     * @param string msg
-     */
-    warning(title: string, msg?: string): void;
-    /**
-     * Public wrapper for accessing the Toastr
-     *
-     * @param string title
-     * @param string msg
-     * @param string mode
-     * @param _options
-     */
-    private toast;
-    /**
-     * Accessing the toastr service
-     *
-     * @param string msg
-     * @param string title
-     * @param options
-     * @param string mode
-     */
-    private doToast;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NotificationService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NotificationService>;
-}

package/lib/service/object-config/object-config.interface.d.ts

@@ -1,62 +0,0 @@
-import { ObjectTypeFieldInternalType } from '../object-form/object-form.interface';
-import { VirtualObjectType } from '../system/system.interface';
-/**
- * Config defining the most important/interessting fields for
- * a certain object type. They'll be used to render result lists
- * as well as headers for onbjects of that type.
- */
-export interface ObjectConfig {
-    objectTypeId: string;
-    icon?: ObjectConfigIcon;
-    title?: ObjectConfigProperty;
-    description?: ObjectConfigProperty;
-    meta?: ObjectConfigProperty;
-    aside?: ObjectConfigProperty;
-    actions?: ObjectConfigAction[];
-    badges?: ObjectConfigBadge[];
-}
-export interface ObjectConfigIcon {
-    svg: string;
-}
-export interface ObjectConfigAction {
-    id: string;
-}
-export interface ObjectConfigBadge {
-    label: string;
-}
-export interface ObjectConfigProperty {
-    label: string;
-    propertyName: string;
-}
-export interface StoredObjectConfig {
-    main: ObjectConfigRecord;
-    buckets: ObjectConfigBucket[];
-}
-export type ObjectConfigRecord = Record<string, ObjectConfig>;
-export interface ObjectConfigBucket {
-    id: string;
-    configs: ObjectConfigRecord;
-}
-export interface ResolvedObjectConfig {
-    id: string;
-    objectTypeId: string;
-    icon?: ResolvedObjectConfigItem;
-    title: ResolvedObjectConfigItem;
-    description?: ResolvedObjectConfigItem;
-    meta?: ResolvedObjectConfigItem;
-    aside?: ResolvedObjectConfigItem;
-    actions?: ObjectConfigAction[];
-    badges?: ObjectConfigBadge[];
-    instanceData?: Record<string, unknown>;
-}
-export interface ResolvedObjectConfigItem {
-    propertyName: string;
-    rendererType?: RendererType;
-    value?: any;
-    meta?: Record<string, any>;
-}
-export type RendererType = Partial<ObjectTypeFieldInternalType | string>;
-export interface ConfigTypeOption {
-    bucket?: string;
-    type: VirtualObjectType;
-}