@yuuvis/client-core 0.6.5

package/index.d.ts

@@ -0,0 +1,61 @@
+export { TranslateDirective, TranslateLoader, TranslateModule, TranslatePipe, TranslateService } from '@ngx-translate/core';
+export * from './lib/client-core.shared.module';
+export * from './lib/model/dms-object.interface';
+export * from './lib/model/object-flavor.interface';
+export * from './lib/model/dms-object.model';
+export * from './lib/model/range-value.interface';
+export * from './lib/model/yuv-error.model';
+export * from './lib/model/yuv-user.model';
+export * from './lib/service/audit/audit.interface';
+export * from './lib/service/audit/audit.service';
+export * from './lib/service/auth/auth.interface';
+export * from './lib/service/auth/auth.service';
+export * from './lib/service/auth/oidc.service';
+export * from './lib/service/backend/api.enum';
+export * from './lib/service/backend/backend.interface';
+export * from './lib/service/backend/backend.service';
+export * from './lib/service/bpm/bpm.service';
+export * from './lib/service/bpm/bpm.interface';
+export * from './lib/service/cache/app-cache.service';
+export * from './lib/service/catalog/catalog.interface';
+export * from './lib/service/catalog/catalog.service';
+export * from './lib/service/clipboard/clipboard.interface';
+export * from './lib/service/clipboard/clipboard.service';
+export * from './lib/service/config/config.interface';
+export * from './lib/service/config/config.service';
+export * from './lib/service/config/core-config';
+export * from './lib/service/config/core-config.tokens';
+export * from './lib/service/connection/connection.service';
+export * from './lib/service/core-init/core-init.service';
+export * from './lib/service/device/device.service';
+export * from './lib/service/device/device.interface';
+export * from './lib/service/dms/dms.service';
+export * from './lib/service/dms/dms.service.interface';
+export * from './lib/service/event/event.interface';
+export * from './lib/service/event/event.service';
+export * from './lib/service/event/events';
+export * from './lib/service/idm/idm.interface';
+export * from './lib/service/idm/idm.service';
+export * from './lib/service/logger/logger';
+export * from './lib/service/notification/notification.service';
+export * from './lib/service/object-config/object-config.interface';
+export * from './lib/service/object-config/object-config.service';
+export * from './lib/service/pending-changes/pending-changes-guard.service';
+export * from './lib/service/pending-changes/pending-changes.service';
+export * from './lib/service/prediction/prediction.interface';
+export * from './lib/service/prediction/prediction.service';
+export * from './lib/service/search/search.service';
+export * from './lib/service/search/search.service.interface';
+export * from './lib/service/session-storage/session-storage.service';
+export * from './lib/service/system/object-form.interface';
+export * from './lib/service/system/system.enum';
+export * from './lib/service/system/system.interface';
+export * from './lib/service/system/system.service';
+export * from './lib/service/upload/upload.interface';
+export * from './lib/service/upload/upload.service';
+export * from './lib/service/user/user.service';
+export * from './lib/util/utils';
+export * from './lib/util/utils.helper.enum';
+export * from './lib/client-core.module';
+export * from './lib/common/pipes';
+export * from './lib/common/services/native-notifications';

package/lib/client-core.module.d.ts

@@ -0,0 +1,20 @@
+import { OAuthStorage } from 'angular-oauth2-oidc';
+import * as i0 from "@angular/core";
+import * as i1 from "angular-oauth2-oidc";
+import * as i2 from "@ngx-translate/core";
+import * as i3 from "./client-core.shared.module";
+export declare function storageFactory(): OAuthStorage;
+/**
+ * `YuvClientCoreModule` provides a bunch of services to interact with a yuuvis backend.
+ *
+ *
+ */
+export declare class YuvClientCoreModule {
+    /**
+     * @ignore
+     */
+    constructor(parentModule: YuvClientCoreModule);
+    static ɵfac: i0.ɵɵFactoryDeclaration<YuvClientCoreModule, [{ optional: true; skipSelf: true; }]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<YuvClientCoreModule, never, [typeof i1.OAuthModule, typeof i2.TranslateModule], [typeof i3.YuvClientCoreSharedModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<YuvClientCoreModule>;
+}

package/lib/client-core.shared.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "@ngx-translate/core";
+/**
+ * `YuvClientCoreSharedModule` sets up and re-exports the TranslateModule.
+ */
+export declare class YuvClientCoreSharedModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<YuvClientCoreSharedModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<YuvClientCoreSharedModule, never, never, [typeof i1.TranslateModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<YuvClientCoreSharedModule>;
+}

package/lib/common/pipes/filesize.pipe.d.ts

@@ -0,0 +1,18 @@
+import { PipeTransform } from '@angular/core';
+import { LocaleNumberPipe } from './locale-number.pipe';
+import * as i0 from "@angular/core";
+/**
+ * This pipe transforms its input (supposed to be a file size in bytes) into a more
+ * human readable format like for example 1MB or 200KB.
+ *
+ * @example
+ * <div *ngFor="let size of file | fileSize">...</div>
+ */
+export declare class FileSizePipe extends LocaleNumberPipe implements PipeTransform {
+    private k;
+    private sizes;
+    transform(bytes?: number): string;
+    stringToNumber(value: string): number;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileSizePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<FileSizePipe, "fileSize", true>;
+}

package/lib/common/pipes/index.d.ts

@@ -0,0 +1,5 @@
+export * from './filesize.pipe';
+export * from './locale-date.pipe';
+export * from './locale-number.pipe';
+export * from './safe-html.pipe';
+export * from './keys.pipe';

package/lib/common/pipes/keys.pipe.d.ts

@@ -0,0 +1,10 @@
+import { PipeTransform } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
+export declare class KeysPipe implements PipeTransform {
+    transform(value: any): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KeysPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<KeysPipe, "keys", true>;
+}

package/lib/common/pipes/locale-date.pipe.d.ts

@@ -0,0 +1,12 @@
+import { PipeTransform } from '@angular/core';
+import { TranslateService } from '@ngx-translate/core';
+import * as i0 from "@angular/core";
+type Formats = 'short' | 'medium' | 'shortDate';
+export declare class LocaleDatePipe implements PipeTransform {
+    translate: TranslateService;
+    constructor(translate: TranslateService);
+    transform(value: string | number | Date | undefined, format?: Formats): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocaleDatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<LocaleDatePipe, "localeDate", true>;
+}
+export {};

package/lib/common/pipes/locale-number.pipe.d.ts

@@ -0,0 +1,47 @@
+import { CurrencyPipe, DecimalPipe, PercentPipe } from '@angular/common';
+import { PipeTransform } from '@angular/core';
+import { TranslateService } from '@ngx-translate/core';
+import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
+export declare class LocaleDecimalPipe extends DecimalPipe implements PipeTransform {
+    translate: TranslateService;
+    constructor(translate: TranslateService);
+    transform(value: any, digits?: string, locale?: string): string | null | any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocaleDecimalPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<LocaleDecimalPipe, "localeDecimal", true>;
+}
+/**
+ * @ignore
+ */
+export declare class LocalePercentPipe extends PercentPipe implements PipeTransform {
+    translate: TranslateService;
+    constructor(translate: TranslateService);
+    transform(value: any, digits?: string, locale?: string): string | null | any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocalePercentPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<LocalePercentPipe, "localePercent", true>;
+}
+/**
+ * @ignore
+ */
+export declare class LocaleCurrencyPipe extends CurrencyPipe implements PipeTransform {
+    translate: TranslateService;
+    constructor(translate: TranslateService);
+    transform(value: any, currencyCode?: string, display?: 'code' | 'symbol' | 'symbol-narrow' | boolean, digits?: string, locale?: string): string | null | any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocaleCurrencyPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<LocaleCurrencyPipe, "localeCurrency", true>;
+}
+export declare class LocaleNumberPipe implements PipeTransform {
+    translate: TranslateService;
+    decimalPipe: LocaleDecimalPipe;
+    decimalSeparator: string;
+    separator: string;
+    constructor(translate: TranslateService);
+    transform(value: any, grouping?: boolean, pattern?: string, scale?: number, digits?: string, locale?: string): string | null;
+    private updateSeparators;
+    stringToNumber(value: string): number;
+    numberToString(value: number, grouping?: boolean, pattern?: string, scale?: number): string | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocaleNumberPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<LocaleNumberPipe, "localeNumber", true>;
+}

package/lib/common/pipes/safe-html.pipe.d.ts

@@ -0,0 +1,28 @@
+import { PipeTransform } from '@angular/core';
+import { DomSanitizer, SafeHtml, SafeResourceUrl } from '@angular/platform-browser';
+import * as i0 from "@angular/core";
+/**
+ * This pipe bypass security and trust the given value to be safe HTML.
+ * Only use this when the bound HTML is unsafe (e.g. contains script tags and the code should be executed.).
+ * @example
+ * <div [innerHtml]="value | safeHtml"></div>
+ */
+export declare class SafeHtmlPipe implements PipeTransform {
+    private sanitizer;
+    constructor(sanitizer: DomSanitizer);
+    transform(style: any): SafeHtml;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SafeHtmlPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SafeHtmlPipe, "safeHtml", true>;
+}
+/**
+ * This pipe bypass security and trust the given value to be a safe style URL, i.e. a value that can be used in hyperlinks or img src.
+ * @example
+ * <iframe [src]="previewSrc | safeUrl"></iframe>
+ */
+export declare class SafeUrlPipe implements PipeTransform {
+    private sanitizer;
+    constructor(sanitizer: DomSanitizer);
+    transform(url: any): SafeResourceUrl;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SafeUrlPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SafeUrlPipe, "safeUrl", true>;
+}

package/lib/common/services/native-notifications.d.ts

@@ -0,0 +1,8 @@
+import { NativeNotificationOptions } from './native-notifications.interface';
+import * as i0 from "@angular/core";
+export declare class NativeNotificationService {
+    requestPermission(): void;
+    showNotification(title: string, options?: NativeNotificationOptions): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NativeNotificationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NativeNotificationService>;
+}

package/lib/common/services/native-notifications.interface.d.ts

@@ -0,0 +1,5 @@
+export interface NativeNotificationOptions {
+    options: NotificationOptions;
+    preventOnTabActive?: boolean;
+    onClick?: () => void;
+}

package/lib/model/dms-object.interface.d.ts

@@ -0,0 +1,16 @@
+export interface DmsObjectPermissions {
+    readIndexData: boolean;
+    readContent: boolean;
+    writeIndexData: boolean;
+    writeContent: boolean;
+    deleteObject: boolean;
+    deleteContent: boolean;
+}
+export interface DmsObjectAuditInfo {
+    on: Date;
+    by: {
+        id: string;
+        title?: string;
+        name?: string;
+    };
+}

package/lib/model/dms-object.model.d.ts

@@ -0,0 +1,26 @@
+import { ContentStream } from '../service/dms/dms.service.interface';
+import { SearchResultItem } from '../service/search/search.service.interface';
+import { DmsObjectAuditInfo, DmsObjectPermissions } from './dms-object.interface';
+/**
+ * `DmsObject` is a business object of a type that  generally contain a document file in addition to its metadata.
+ *  Document file can be text documents, e-mails, image files, video, etc.
+ *  Each object type classifies the object and defines the properties that the object must have or is allowed to have.
+ */
+export declare class DmsObject {
+    #private;
+    id: string;
+    parentId: string;
+    content?: ContentStream;
+    data: Record<string, unknown>;
+    isFolder: boolean;
+    objectTypeId: string;
+    permissions?: DmsObjectPermissions;
+    version: number;
+    created: DmsObjectAuditInfo;
+    modified: DmsObjectAuditInfo;
+    sots: string[];
+    /**
+     * @ignore
+     */
+    constructor(searchResultItem: SearchResultItem);
+}

package/lib/model/object-flavor.interface.d.ts

@@ -0,0 +1,30 @@
+import { Type } from '@angular/core';
+import { DmsObject } from './dms-object.model';
+export interface FlavoredDmsObject {
+    object: DmsObject;
+    flavors: ObjectTypeFlavor[];
+}
+export interface ObjectTypeFlavor {
+    id: string;
+    icon?: string;
+    sot: string;
+    applicableTo?: {
+        mimeTypes: string[];
+    };
+}
+/**
+ * Create flavors can be used to provide a specific way of creating objects.
+ */
+export interface ObjectCreateFlavor {
+    id: string;
+    descriptionKey?: string;
+    icon?: string;
+    withFileUpload?: {
+        applicableTo?: {
+            mimeTypes: string[];
+        };
+        multiple?: boolean;
+    };
+    sot?: string;
+    applyComponent?: Type<any>;
+}

package/lib/model/range-value.interface.d.ts

@@ -0,0 +1,9 @@
+import { Operator } from "../service/search/search.service.interface";
+/**
+ * Value class to be used with form elements that support ranges
+ */
+export interface RangeValue {
+    operator: Operator;
+    firstValue: unknown;
+    secondValue?: unknown;
+}

package/lib/model/yuv-error.model.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @ignore
+ */
+export declare class YuvError implements Error {
+    originalError: any | Error;
+    private _name?;
+    private _message?;
+    private _skipNotification;
+    get name(): any;
+    get message(): any;
+    get stack(): any;
+    get status(): any;
+    get url(): any;
+    get skipNotification(): boolean;
+    get isHttpErrorResponse(): any;
+    constructor(originalError: any | Error, _name?: string | undefined, _message?: string | undefined, _skipNotification?: boolean);
+    toString(): any;
+}

package/lib/model/yuv-user.model.d.ts

@@ -0,0 +1,44 @@
+/**
+ * User account configuration
+ */
+export declare class YuvUser {
+    private DEFAULT_USER_LOCALE;
+    id: string;
+    username: string;
+    firstname: string;
+    lastname: string;
+    title: string;
+    email: string;
+    image: string;
+    tenant: string;
+    domain: string;
+    authorities: string[];
+    substituteOf: string[];
+    enabled: boolean;
+    /**
+     * User settings
+     */
+    uiDirection?: string;
+    /**
+     * User settings
+     */
+    userSettings: UserSettings;
+    /**
+     * @ignore
+     */
+    constructor(json: any, userSettings?: UserSettings);
+    /**
+     * Gets the users configured client locale
+     * @returns locale string
+     */
+    getClientLocale(fallback?: string): string;
+    getFullName(): string;
+    getDisplayNameName(): string;
+}
+/**
+ * Interface for user settings
+ */
+export interface UserSettings {
+    locale: string;
+    clientAppSettings?: Record<string, any>;
+}

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

@@ -0,0 +1,47 @@
+import { SearchQuery } from "../search/search.service.interface";
+/**
+ * Is a part of `AuditQueryResult` interface
+ */
+export interface AuditEntry {
+    action: number;
+    actionGroup: number;
+    detail: string;
+    subaction?: number;
+    creationDate: Date;
+    version: number;
+    createdBy: {
+        id: string;
+        title: string;
+    };
+    more?: string;
+}
+/**
+ * Interface for a result object of a former audits query
+ */
+export interface AuditQueryResult {
+    /**
+     * the original query, needed for later on paging requests
+     */
+    query: SearchQuery;
+    items: AuditEntry[];
+    hasMoreItems: boolean;
+    /**
+     * the page of the current result (in case of multi-page results, otherwise 1)
+     */
+    page: number;
+}
+export interface AuditQueryOptions {
+    /**
+     * List of actions (codes) to restricts the audits to
+     */
+    actions?: string[];
+    /**
+     * Actions that should explicitly NOT be fetched
+     */
+    skipActions?: number[];
+    /**
+     * Whether or not to query all audit entries, without the user
+     * or admin filter conditions
+     */
+    allActions?: boolean;
+}

package/lib/service/audit/audit.service.d.ts

@@ -0,0 +1,35 @@
+import { Observable } from 'rxjs';
+import { AuditQueryOptions, AuditQueryResult } from './audit.interface';
+import * as i0 from "@angular/core";
+/**
+ * Service providing access to the systems audit entries. Audits can be seen as the history of
+ * an object. Actions perormed on an object (eg. read, write, delete, ...) will be recorded during
+ * the objects lifecycle. Audits are provided based on a users permissions. Beside the audit entries
+ * visible to regular users there are more technical ones that will only be shown to users that
+ * have administrative role.
+ */
+export declare class AuditService {
+    #private;
+    private DEFAULT_RES_SIZE;
+    private userAuditActions;
+    private adminAuditActions;
+    /**
+     * Get audit entries of a dms object
+     */
+    getAuditEntries(id: string, options?: AuditQueryOptions): Observable<AuditQueryResult>;
+    /**
+     * Get an array of action codes that are provided by the service. Based on
+     * whether or not the user has admin permissions you'll get a different
+     * set of actions.
+     * @param skipActions codes of actions that should not be fetched
+     */
+    getAuditActions(allActions: boolean, skipActions?: number[]): number[];
+    /**
+     * Get a certain page for a former audits query.
+     * @param auditsResult The result object of a former audits query
+     * @param page The page to load
+     */
+    getPage(auditsResult: AuditQueryResult, page: number): Observable<AuditQueryResult>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuditService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuditService>;
+}

package/lib/service/auth/auth.interceptor.d.ts

@@ -0,0 +1,12 @@
+import { HttpEvent, HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Prevent app from running into 401 issues related to gateway timeouts.
+ */
+export declare class AuthInterceptor implements HttpInterceptor {
+    #private;
+    intercept(request: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuthInterceptor, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuthInterceptor>;
+}

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

@@ -0,0 +1,34 @@
+/**
+ * Result when calling loginDevice endpoint in cloud environment
+ * when using device flow
+ */
+export interface LoginDeviceResult {
+    user_code: string;
+    device_code: string;
+    interval: number;
+    verification_uri: string;
+    expires_in: number;
+}
+/**
+ * @ignore
+ */
+export interface StoredToken {
+    accessToken: string;
+    tenant: string;
+}
+/**
+ * State emitted by the login function when using the device flow
+ */
+export interface LoginState {
+    name: LoginStateName;
+    data: any;
+}
+export declare enum LoginStateName {
+    STATE_LOGIN_URI = "login.uri",
+    STATE_DONE = "login.done",
+    STATE_CANCELED = "login.canceled"
+}
+export interface YuvInitError {
+    status: number;
+    key: string;
+}

package/lib/service/auth/auth.service.d.ts

@@ -0,0 +1,50 @@
+import { Observable } from 'rxjs';
+import { YuvUser } from '../../model/yuv-user.model';
+import { CoreConfig } from '../config/core-config';
+import { YuvInitError } from './auth.interface';
+import * as i0 from "@angular/core";
+/**
+ * Service handling authentication related issues.
+ */
+export declare class AuthService {
+    #private;
+    coreConfig: CoreConfig;
+    readonly USER_FETCH_URI = "/idm/whoami";
+    authenticated$: Observable<boolean>;
+    initError?: YuvInitError;
+    constructor(coreConfig: CoreConfig);
+    isLoggedIn(): boolean;
+    /**
+     * Called while app/core is initialized (APP_INITIALIZER)
+     * @ignore
+     */
+    initUser(): Observable<YuvUser>;
+    /**
+     * Get the current tenant or the previous one persisted locally
+     */
+    getTenant(): string;
+    /**
+     * Fetch information about the user currently logged in
+     */
+    fetchUser(): Observable<YuvUser>;
+    /**
+     * Logs out the current user.
+     */
+    logout(): void;
+    setInitialRequestUri(): void;
+    /**
+     * Get the URL that entered the app. May be a deep link that could then be
+     * picked up again after user has been authenticated.
+     */
+    getInitialRequestUri(): Observable<{
+        uri: string;
+        timestamp: number;
+    }>;
+    resetInitialRequestUri(): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuthService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuthService>;
+}
+export interface AuthData {
+    tenant: string;
+    language: string;
+}

package/lib/service/auth/oidc.service.d.ts

@@ -0,0 +1,16 @@
+import { OAuthModuleConfig, OAuthService } from 'angular-oauth2-oidc';
+import { Observable } from 'rxjs';
+import { OpenIdConfig } from '../backend/backend.interface';
+import { CoreConfig } from '../config/core-config';
+import * as i0 from "@angular/core";
+export declare class OidcService {
+    private oAuthConfig;
+    config: CoreConfig;
+    private oauthService;
+    constructor(oAuthConfig: OAuthModuleConfig, config: CoreConfig, oauthService: OAuthService);
+    initOpenIdConnect(oidc: OpenIdConfig | undefined): Observable<OpenIdConfig | undefined>;
+    logout(): void;
+    setupCookie(viewer: string, path: string, headers: any): Observable<unknown>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OidcService, [{ optional: true; }, null, null]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OidcService>;
+}

package/lib/service/backend/api.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum ApiBase {
+    core = "api",
+    apiWeb = "api-web/api",
+    predict = "predict-api/api",
+    custom = "custom",
+    none = ""
+}

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

@@ -0,0 +1,29 @@
+import { HttpHeaders, HttpParams } from '@angular/common/http';
+export interface OpenIdConfig {
+    host: string;
+    tenant: string;
+    issuer: string;
+    clientId: string;
+    redirectUri?: string;
+    postLogoutRedirectUri?: string;
+}
+/**
+ * HttpOptions for http request
+ * @param observe: 'body' | 'events' | 'response'
+ * @param responseType: 'arraybuffer' | 'blob' | 'json' | 'text'
+ */
+export interface HttpOptions {
+    headers?: HttpHeaders | {
+        [header: string]: string | string[];
+    };
+    observe?: any;
+    params?: HttpParams | {
+        [param: string]: string | string[];
+    };
+    reportProgress?: boolean;
+    responseType?: any;
+    withCredentials?: boolean;
+}
+export interface HttpDeleteOptions extends HttpOptions {
+    body?: any;
+}