@yuuvis/client-core 3.0.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/yuuvis-client-core.mjs +2444 -2096
- package/fesm2022/yuuvis-client-core.mjs.map +1 -1
- package/package.json +1 -1
- package/types/yuuvis-client-core.d.ts +521 -270
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { TranslateService } from '@ngx-translate/core';
|
|
2
|
-
export { TranslateDirective, TranslateLoader, TranslateModule, TranslatePipe, TranslateService } from '@ngx-translate/core';
|
|
1
|
+
import { MissingTranslationHandler, MissingTranslationHandlerParams, TranslateLoader, TranslateService } from '@ngx-translate/core';
|
|
2
|
+
export { TranslateDirective, TranslateLoader, TranslateModule, TranslatePipe, TranslateService, _ as marker } from '@ngx-translate/core';
|
|
3
3
|
import * as i0 from '@angular/core';
|
|
4
|
-
import { Type,
|
|
4
|
+
import { Type, InjectionToken, Signal, DoCheck, Provider, PipeTransform, EnvironmentProviders } from '@angular/core';
|
|
5
5
|
import { Router, CanDeactivate } from '@angular/router';
|
|
6
|
+
import { HttpRequest, HttpHandlerFn, HttpEvent, HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
|
|
6
7
|
import * as rxjs from 'rxjs';
|
|
7
8
|
import { Observable, Subscription } from 'rxjs';
|
|
8
|
-
import { HttpHeaders, HttpParams } from '@angular/common/http';
|
|
9
9
|
import * as _yuuvis_client_core from '@yuuvis/client-core';
|
|
10
10
|
import { DeviceInfo } from 'ngx-device-detector';
|
|
11
11
|
import { FormControl, FormGroup } from '@angular/forms';
|
|
@@ -489,86 +489,9 @@ interface UserSettings {
|
|
|
489
489
|
}
|
|
490
490
|
|
|
491
491
|
/**
|
|
492
|
-
*
|
|
493
|
-
*/
|
|
494
|
-
interface AuditEntry {
|
|
495
|
-
action: number;
|
|
496
|
-
actionGroup: number;
|
|
497
|
-
detail: string;
|
|
498
|
-
subaction?: number;
|
|
499
|
-
creationDate: Date;
|
|
500
|
-
version: number;
|
|
501
|
-
createdBy: {
|
|
502
|
-
id: string;
|
|
503
|
-
title: string;
|
|
504
|
-
};
|
|
505
|
-
more?: string;
|
|
506
|
-
}
|
|
507
|
-
/**
|
|
508
|
-
* Interface for a result object of a former audits query
|
|
492
|
+
* Prevent app from running into 401 issues related to gateway timeouts.
|
|
509
493
|
*/
|
|
510
|
-
|
|
511
|
-
/**
|
|
512
|
-
* the original query, needed for later on paging requests
|
|
513
|
-
*/
|
|
514
|
-
query: SearchQuery;
|
|
515
|
-
items: AuditEntry[];
|
|
516
|
-
hasMoreItems: boolean;
|
|
517
|
-
/**
|
|
518
|
-
* the page of the current result (in case of multi-page results, otherwise 1)
|
|
519
|
-
*/
|
|
520
|
-
page: number;
|
|
521
|
-
}
|
|
522
|
-
interface AuditQueryOptions {
|
|
523
|
-
/**
|
|
524
|
-
* List of actions (codes) to restricts the audits to
|
|
525
|
-
*/
|
|
526
|
-
actions?: string[];
|
|
527
|
-
/**
|
|
528
|
-
* Actions that should explicitly NOT be fetched
|
|
529
|
-
*/
|
|
530
|
-
skipActions?: number[];
|
|
531
|
-
/**
|
|
532
|
-
* Whether or not to query all audit entries, without the user
|
|
533
|
-
* or admin filter conditions
|
|
534
|
-
*/
|
|
535
|
-
allActions?: boolean;
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
/**
|
|
539
|
-
* Service providing access to the systems audit entries. Audits can be seen as the history of
|
|
540
|
-
* an object. Actions perormed on an object (eg. read, write, delete, ...) will be recorded during
|
|
541
|
-
* the objects lifecycle. Audits are provided based on a users permissions. Beside the audit entries
|
|
542
|
-
* visible to regular users there are more technical ones that will only be shown to users that
|
|
543
|
-
* have administrative role.
|
|
544
|
-
*/
|
|
545
|
-
declare class AuditService {
|
|
546
|
-
#private;
|
|
547
|
-
private DEFAULT_RES_SIZE;
|
|
548
|
-
private userAuditActions;
|
|
549
|
-
private adminAuditActions;
|
|
550
|
-
/**
|
|
551
|
-
* Get audit entries of a dms object
|
|
552
|
-
* @param id The id of the object to get the audit entries for
|
|
553
|
-
* @param options Options
|
|
554
|
-
*/
|
|
555
|
-
getAuditEntries(id: string, options?: AuditQueryOptions): Observable<AuditQueryResult>;
|
|
556
|
-
/**
|
|
557
|
-
* Get an array of action codes that are provided by the service. Based on
|
|
558
|
-
* whether or not the user has admin permissions you'll get a different
|
|
559
|
-
* set of actions.
|
|
560
|
-
* @param skipActions codes of actions that should not be fetched
|
|
561
|
-
*/
|
|
562
|
-
getAuditActions(allActions: boolean, skipActions?: number[]): number[];
|
|
563
|
-
/**
|
|
564
|
-
* Get a certain page for a former audits query.
|
|
565
|
-
* @param auditsResult The result object of a former audits query
|
|
566
|
-
* @param page The page to load
|
|
567
|
-
*/
|
|
568
|
-
getPage(auditsResult: AuditQueryResult, page: number): Observable<AuditQueryResult>;
|
|
569
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<AuditService, never>;
|
|
570
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<AuditService>;
|
|
571
|
-
}
|
|
494
|
+
declare function AuthInterceptorFnc(req: HttpRequest<unknown>, next: HttpHandlerFn): Observable<HttpEvent<unknown>>;
|
|
572
495
|
|
|
573
496
|
/**
|
|
574
497
|
* Result when calling loginDevice endpoint in cloud environment
|
|
@@ -702,35 +625,6 @@ interface AuthData {
|
|
|
702
625
|
language: string;
|
|
703
626
|
}
|
|
704
627
|
|
|
705
|
-
declare enum ApiBase {
|
|
706
|
-
core = "api",
|
|
707
|
-
apiWeb = "api-web/api",
|
|
708
|
-
predict = "predict-api/api",
|
|
709
|
-
custom = "custom",
|
|
710
|
-
none = ""
|
|
711
|
-
}
|
|
712
|
-
|
|
713
|
-
/**
|
|
714
|
-
* HttpOptions for http request
|
|
715
|
-
* @param observe: 'body' | 'events' | 'response'
|
|
716
|
-
* @param responseType: 'arraybuffer' | 'blob' | 'json' | 'text'
|
|
717
|
-
*/
|
|
718
|
-
interface HttpOptions {
|
|
719
|
-
headers?: HttpHeaders | {
|
|
720
|
-
[header: string]: string | string[];
|
|
721
|
-
};
|
|
722
|
-
observe?: any;
|
|
723
|
-
params?: HttpParams | {
|
|
724
|
-
[param: string]: string | string[];
|
|
725
|
-
};
|
|
726
|
-
reportProgress?: boolean;
|
|
727
|
-
responseType?: any;
|
|
728
|
-
withCredentials?: boolean;
|
|
729
|
-
}
|
|
730
|
-
interface HttpDeleteOptions extends HttpOptions {
|
|
731
|
-
body?: any;
|
|
732
|
-
}
|
|
733
|
-
|
|
734
628
|
/**
|
|
735
629
|
* Load and provide configuration for hole apllication while application is inizialized.
|
|
736
630
|
*/
|
|
@@ -767,6 +661,192 @@ declare class ConfigService {
|
|
|
767
661
|
static ɵprov: i0.ɵɵInjectableDeclaration<ConfigService>;
|
|
768
662
|
}
|
|
769
663
|
|
|
664
|
+
/**
|
|
665
|
+
* @ignore
|
|
666
|
+
*/
|
|
667
|
+
declare const CUSTOM_CONFIG: InjectionToken<CoreConfig>;
|
|
668
|
+
declare const CORE_CONFIG: InjectionToken<CoreConfig>;
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
* Service to monitor the online/offline state of the application.
|
|
672
|
+
* It listens to the browser's online and offline events and provides an observable
|
|
673
|
+
* to track the current connection state.
|
|
674
|
+
*
|
|
675
|
+
* An observable `connection$` is provided which emits the current connection state
|
|
676
|
+
* whenever the online or offline state changes. The initial state is determined by
|
|
677
|
+
* the `window.navigator.onLine` property.
|
|
678
|
+
*/
|
|
679
|
+
declare class ConnectionService {
|
|
680
|
+
private currentState;
|
|
681
|
+
private connectionStateSource;
|
|
682
|
+
connection$: Observable<ConnectionState>;
|
|
683
|
+
/**
|
|
684
|
+
* @ignore
|
|
685
|
+
*/
|
|
686
|
+
constructor();
|
|
687
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ConnectionService, never>;
|
|
688
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ConnectionService>;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* Check a connection state of a client
|
|
692
|
+
*/
|
|
693
|
+
interface ConnectionState {
|
|
694
|
+
/**
|
|
695
|
+
* whether or not the application is online.
|
|
696
|
+
*/
|
|
697
|
+
isOnline: boolean;
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
/**
|
|
701
|
+
* Http Offline interceptor trys to serving offline content for method/url
|
|
702
|
+
*/
|
|
703
|
+
declare function OfflineInterceptorFnc(req: HttpRequest<unknown>, next: HttpHandlerFn): Observable<HttpEvent<unknown>>;
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
* Providing functions,that are are injected at application startup and executed during app initialization.
|
|
707
|
+
*/
|
|
708
|
+
declare const init_moduleFnc: () => rxjs.Observable<boolean | _yuuvis_client_core.YuvUser | YuvConfig[]>;
|
|
709
|
+
|
|
710
|
+
/**
|
|
711
|
+
* Handles missing translations
|
|
712
|
+
* @ignore
|
|
713
|
+
*/
|
|
714
|
+
declare class EoxMissingTranslationHandler implements MissingTranslationHandler {
|
|
715
|
+
handle(params: MissingTranslationHandlerParams): string;
|
|
716
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EoxMissingTranslationHandler, never>;
|
|
717
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EoxMissingTranslationHandler>;
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* Loader that fetches translations based on the configured locations
|
|
722
|
+
* @ignore
|
|
723
|
+
*/
|
|
724
|
+
declare class EoxTranslateJsonLoader implements TranslateLoader {
|
|
725
|
+
http: HttpClient;
|
|
726
|
+
config: CoreConfig;
|
|
727
|
+
constructor(http: HttpClient, config: CoreConfig);
|
|
728
|
+
/**
|
|
729
|
+
*
|
|
730
|
+
* @param string lang
|
|
731
|
+
* @returns Observable<Object>
|
|
732
|
+
*/
|
|
733
|
+
getTranslation(lang: string): Observable<Record<string, string>>;
|
|
734
|
+
private loadTranslationFile;
|
|
735
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EoxTranslateJsonLoader, never>;
|
|
736
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EoxTranslateJsonLoader>;
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
/**
|
|
740
|
+
* Is a part of `AuditQueryResult` interface
|
|
741
|
+
*/
|
|
742
|
+
interface AuditEntry {
|
|
743
|
+
action: number;
|
|
744
|
+
actionGroup: number;
|
|
745
|
+
detail: string;
|
|
746
|
+
subaction?: number;
|
|
747
|
+
creationDate: Date;
|
|
748
|
+
version: number;
|
|
749
|
+
createdBy: {
|
|
750
|
+
id: string;
|
|
751
|
+
title: string;
|
|
752
|
+
};
|
|
753
|
+
more?: string;
|
|
754
|
+
}
|
|
755
|
+
/**
|
|
756
|
+
* Interface for a result object of a former audits query
|
|
757
|
+
*/
|
|
758
|
+
interface AuditQueryResult {
|
|
759
|
+
/**
|
|
760
|
+
* the original query, needed for later on paging requests
|
|
761
|
+
*/
|
|
762
|
+
query: SearchQuery;
|
|
763
|
+
items: AuditEntry[];
|
|
764
|
+
hasMoreItems: boolean;
|
|
765
|
+
/**
|
|
766
|
+
* the page of the current result (in case of multi-page results, otherwise 1)
|
|
767
|
+
*/
|
|
768
|
+
page: number;
|
|
769
|
+
}
|
|
770
|
+
interface AuditQueryOptions {
|
|
771
|
+
/**
|
|
772
|
+
* List of actions (codes) to restricts the audits to
|
|
773
|
+
*/
|
|
774
|
+
actions?: string[];
|
|
775
|
+
/**
|
|
776
|
+
* Actions that should explicitly NOT be fetched
|
|
777
|
+
*/
|
|
778
|
+
skipActions?: number[];
|
|
779
|
+
/**
|
|
780
|
+
* Whether or not to query all audit entries, without the user
|
|
781
|
+
* or admin filter conditions
|
|
782
|
+
*/
|
|
783
|
+
allActions?: boolean;
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* Service providing access to the systems audit entries. Audits can be seen as the history of
|
|
788
|
+
* an object. Actions perormed on an object (eg. read, write, delete, ...) will be recorded during
|
|
789
|
+
* the objects lifecycle. Audits are provided based on a users permissions. Beside the audit entries
|
|
790
|
+
* visible to regular users there are more technical ones that will only be shown to users that
|
|
791
|
+
* have administrative role.
|
|
792
|
+
*/
|
|
793
|
+
declare class AuditService {
|
|
794
|
+
#private;
|
|
795
|
+
private DEFAULT_RES_SIZE;
|
|
796
|
+
private userAuditActions;
|
|
797
|
+
private adminAuditActions;
|
|
798
|
+
/**
|
|
799
|
+
* Get audit entries of a dms object
|
|
800
|
+
* @param id The id of the object to get the audit entries for
|
|
801
|
+
* @param options Options
|
|
802
|
+
*/
|
|
803
|
+
getAuditEntries(id: string, options?: AuditQueryOptions): Observable<AuditQueryResult>;
|
|
804
|
+
/**
|
|
805
|
+
* Get an array of action codes that are provided by the service. Based on
|
|
806
|
+
* whether or not the user has admin permissions you'll get a different
|
|
807
|
+
* set of actions.
|
|
808
|
+
* @param skipActions codes of actions that should not be fetched
|
|
809
|
+
*/
|
|
810
|
+
getAuditActions(allActions: boolean, skipActions?: number[]): number[];
|
|
811
|
+
/**
|
|
812
|
+
* Get a certain page for a former audits query.
|
|
813
|
+
* @param auditsResult The result object of a former audits query
|
|
814
|
+
* @param page The page to load
|
|
815
|
+
*/
|
|
816
|
+
getPage(auditsResult: AuditQueryResult, page: number): Observable<AuditQueryResult>;
|
|
817
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<AuditService, never>;
|
|
818
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<AuditService>;
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
declare enum ApiBase {
|
|
822
|
+
core = "api",
|
|
823
|
+
apiWeb = "api-web/api",
|
|
824
|
+
predict = "predict-api/api",
|
|
825
|
+
custom = "custom",
|
|
826
|
+
none = ""
|
|
827
|
+
}
|
|
828
|
+
|
|
829
|
+
/**
|
|
830
|
+
* HttpOptions for http request
|
|
831
|
+
* @param observe: 'body' | 'events' | 'response'
|
|
832
|
+
* @param responseType: 'arraybuffer' | 'blob' | 'json' | 'text'
|
|
833
|
+
*/
|
|
834
|
+
interface HttpOptions {
|
|
835
|
+
headers?: HttpHeaders | {
|
|
836
|
+
[header: string]: string | string[];
|
|
837
|
+
};
|
|
838
|
+
observe?: any;
|
|
839
|
+
params?: HttpParams | {
|
|
840
|
+
[param: string]: string | string[];
|
|
841
|
+
};
|
|
842
|
+
reportProgress?: boolean;
|
|
843
|
+
responseType?: any;
|
|
844
|
+
withCredentials?: boolean;
|
|
845
|
+
}
|
|
846
|
+
interface HttpDeleteOptions extends HttpOptions {
|
|
847
|
+
body?: any;
|
|
848
|
+
}
|
|
849
|
+
|
|
770
850
|
/**
|
|
771
851
|
* Service for HTTP communication with the yuuvis Momentum backend.
|
|
772
852
|
*
|
|
@@ -1026,13 +1106,13 @@ declare class AppCacheService {
|
|
|
1026
1106
|
* @param value The value to store.
|
|
1027
1107
|
* @returns An Observable that emits true when the operation is successful.
|
|
1028
1108
|
*/
|
|
1029
|
-
setItem<T =
|
|
1109
|
+
setItem<T = unknown>(key: string, value: T): Observable<boolean>;
|
|
1030
1110
|
/**
|
|
1031
1111
|
* Get item from storage.
|
|
1032
1112
|
* @param key The key of the item to retrieve.
|
|
1033
1113
|
* @returns An Observable that emits the retrieved value.
|
|
1034
1114
|
*/
|
|
1035
|
-
getItem<T =
|
|
1115
|
+
getItem<T = unknown>(key: string): Observable<T>;
|
|
1036
1116
|
/**
|
|
1037
1117
|
* Remove item from storage.
|
|
1038
1118
|
* @param key The key of the item to remove.
|
|
@@ -1044,31 +1124,165 @@ declare class AppCacheService {
|
|
|
1044
1124
|
* @param filter A function to filter which keys to clear.
|
|
1045
1125
|
* @returns An Observable that emits true when the operation is successful.
|
|
1046
1126
|
*/
|
|
1047
|
-
clear(filter?: (key:
|
|
1127
|
+
clear(filter?: (key: string) => boolean): Observable<boolean>;
|
|
1048
1128
|
/**
|
|
1049
1129
|
* Get all storage keys.
|
|
1050
1130
|
* @returns An Observable that emits an array of all storage keys.
|
|
1051
1131
|
*/
|
|
1052
1132
|
getStorageKeys(): Observable<string[]>;
|
|
1053
|
-
setStorage(options:
|
|
1133
|
+
setStorage(options: Record<string, unknown>): Observable<unknown>;
|
|
1054
1134
|
static ɵfac: i0.ɵɵFactoryDeclaration<AppCacheService, never>;
|
|
1055
1135
|
static ɵprov: i0.ɵɵInjectableDeclaration<AppCacheService>;
|
|
1056
1136
|
}
|
|
1057
1137
|
|
|
1058
|
-
interface
|
|
1059
|
-
|
|
1060
|
-
|
|
1138
|
+
interface CatalogLocalization {
|
|
1139
|
+
locale: string;
|
|
1140
|
+
label: string;
|
|
1141
|
+
description: string;
|
|
1061
1142
|
}
|
|
1062
|
-
interface
|
|
1063
|
-
|
|
1064
|
-
|
|
1143
|
+
interface CatalogLocalizationPayload {
|
|
1144
|
+
columnNames: string[];
|
|
1145
|
+
value: string[][];
|
|
1065
1146
|
}
|
|
1147
|
+
declare const LOCALIZATION_COLUMNS: string[];
|
|
1148
|
+
/** Property wrapper as returned by the OData catalog API */
|
|
1149
|
+
interface CatalogApiPropertyValue {
|
|
1150
|
+
value: unknown;
|
|
1151
|
+
}
|
|
1152
|
+
/** Single object in the OData response `objects` array */
|
|
1153
|
+
interface CatalogApiObject {
|
|
1154
|
+
properties: Record<string, CatalogApiPropertyValue>;
|
|
1155
|
+
}
|
|
1156
|
+
/** OData catalog response envelope */
|
|
1157
|
+
interface CatalogApiResponse {
|
|
1158
|
+
objects: CatalogApiObject[];
|
|
1159
|
+
numItems: number;
|
|
1160
|
+
hasMoreItems: boolean;
|
|
1161
|
+
totalNumItems: number;
|
|
1162
|
+
}
|
|
1163
|
+
/** A catalog entry mapped from the raw OData response */
|
|
1066
1164
|
interface CatalogEntry {
|
|
1165
|
+
/** UUID of the catalog entry (system:objectId) */
|
|
1166
|
+
objectId: string;
|
|
1167
|
+
/** The entry key / name (system:nativeId) */
|
|
1067
1168
|
name: string;
|
|
1068
|
-
|
|
1169
|
+
/** The catalog this entry belongs to (system:catalogNativeId) */
|
|
1170
|
+
catalogName: string;
|
|
1171
|
+
/** Localized labels and descriptions */
|
|
1172
|
+
localizations: CatalogLocalization[];
|
|
1173
|
+
/** Validity start date (ISO 8601), if set */
|
|
1174
|
+
validFrom?: string;
|
|
1175
|
+
/** Validity end date (ISO 8601), if set */
|
|
1176
|
+
validUntil?: string;
|
|
1177
|
+
/** Additional catalog-specific properties (app prefix stripped) */
|
|
1178
|
+
properties: Record<string, unknown>;
|
|
1179
|
+
}
|
|
1180
|
+
/** Paginated result of catalog entries */
|
|
1181
|
+
interface CatalogResult {
|
|
1182
|
+
entries: CatalogEntry[];
|
|
1183
|
+
hasMoreItems: boolean;
|
|
1184
|
+
totalNumItems: number;
|
|
1185
|
+
}
|
|
1186
|
+
/** A catalog (system:catalog) — mapped from a DmsObject */
|
|
1187
|
+
interface Catalog {
|
|
1188
|
+
/** UUID of the catalog object */
|
|
1189
|
+
objectId: string;
|
|
1190
|
+
/** Technical name (system:nativeId), unique per tenant, immutable */
|
|
1191
|
+
name: string;
|
|
1192
|
+
}
|
|
1193
|
+
/** Payload for creating a catalog */
|
|
1194
|
+
interface CatalogPayload {
|
|
1195
|
+
/** Technical name. Must be unique per tenant and is immutable after creation. */
|
|
1196
|
+
name: string;
|
|
1197
|
+
}
|
|
1198
|
+
/** Payload for creating a new catalog entry */
|
|
1199
|
+
interface CatalogEntryCreatePayload {
|
|
1200
|
+
/** Technical name (system:nativeId). Unique within the catalog, immutable. */
|
|
1201
|
+
name: string;
|
|
1202
|
+
/** Catalog-specific SOT ids. Added on top of `system:catalogEntry`. */
|
|
1203
|
+
secondaryObjectTypeIds?: string[];
|
|
1204
|
+
localizations?: CatalogLocalization[];
|
|
1205
|
+
validFrom?: string;
|
|
1206
|
+
validUntil?: string;
|
|
1207
|
+
/** Catalog-specific properties — keyed by FULL prefix (e.g. `appCountries:continent`). */
|
|
1208
|
+
properties?: Record<string, unknown>;
|
|
1209
|
+
}
|
|
1210
|
+
/** Payload for updating a catalog entry. `name` and `catalogName` are immutable. */
|
|
1211
|
+
interface CatalogEntryUpdatePayload {
|
|
1212
|
+
catalogName: string;
|
|
1213
|
+
localizations?: CatalogLocalization[];
|
|
1214
|
+
/** Pass `null` to clear the value. */
|
|
1215
|
+
validFrom?: string | null;
|
|
1216
|
+
/** Pass `null` to clear the value. */
|
|
1217
|
+
validUntil?: string | null;
|
|
1218
|
+
}
|
|
1219
|
+
/** A property filter for OData $filter */
|
|
1220
|
+
interface CatalogPropertyFilter {
|
|
1221
|
+
/** Property name WITHOUT its app prefix (e.g. 'continent', not 'appCatalogtest:continent') */
|
|
1222
|
+
property: string;
|
|
1223
|
+
/** The value to compare against */
|
|
1224
|
+
value: string;
|
|
1225
|
+
}
|
|
1226
|
+
/** Options for querying catalog entries */
|
|
1227
|
+
interface CatalogQueryOptions {
|
|
1228
|
+
/** Maximum number of entries to return (maps to $top, default 50) */
|
|
1229
|
+
top?: number;
|
|
1230
|
+
/** Number of entries to skip (maps to $skip, default 0) */
|
|
1231
|
+
skip?: number;
|
|
1232
|
+
/** Include expired/not-yet-valid entries */
|
|
1233
|
+
includeInvalidEntries?: boolean;
|
|
1234
|
+
/** Autocomplete prefix — maps to startswith(displayValue, '...') */
|
|
1235
|
+
autocompletePrefix?: string;
|
|
1236
|
+
/** Property filters — combined with 'and' */
|
|
1237
|
+
filters?: CatalogPropertyFilter[];
|
|
1238
|
+
/**
|
|
1239
|
+
* BCP-47 locale tag (e.g. `de`, `en`). Forwarded as `Accept-Language`.
|
|
1240
|
+
* Drives `startswith(displayValue,'…')` matching and the row of
|
|
1241
|
+
* `system:localization` returned in the response. When omitted, the
|
|
1242
|
+
* backend default applies.
|
|
1243
|
+
*/
|
|
1244
|
+
locale?: string;
|
|
1069
1245
|
}
|
|
1070
1246
|
|
|
1071
1247
|
declare class CatalogService {
|
|
1248
|
+
#private;
|
|
1249
|
+
static readonly CATALOG_BASE = "/dms/catalogs/odata";
|
|
1250
|
+
catalogs: i0.WritableSignal<Catalog[]>;
|
|
1251
|
+
/** Fetch the list of catalogs and publish to the `catalogs` signal. */
|
|
1252
|
+
loadCatalogs(): Observable<Catalog[]>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Create a new catalog. Returns the new objectId.
|
|
1255
|
+
*/
|
|
1256
|
+
createCatalog(payload: CatalogPayload): Observable<string>;
|
|
1257
|
+
/** Delete a catalog by objectId. */
|
|
1258
|
+
deleteCatalog(objectId: string): Observable<unknown>;
|
|
1259
|
+
/** Create a new entry in the given catalog. Returns the new objectId. */
|
|
1260
|
+
createEntry(catalogName: string, payload: CatalogEntryCreatePayload): Observable<string>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Update mutable fields of a catalog entry. Sparse: only fields present in `update`
|
|
1263
|
+
* are sent. Pass `null` for `validFrom`/`validUntil` to clear them.
|
|
1264
|
+
*/
|
|
1265
|
+
updateEntry(objectId: string, update: CatalogEntryUpdatePayload): Observable<DmsObject>;
|
|
1266
|
+
/** Delete a catalog entry by objectId. */
|
|
1267
|
+
deleteEntry(objectId: string): Observable<unknown>;
|
|
1268
|
+
/**
|
|
1269
|
+
* Get a specific catalog entry by name (use case 1).
|
|
1270
|
+
* Validity filtering does NOT apply — all existing entries are returned.
|
|
1271
|
+
* Returns 404 if the entry does not exist. Pass `locale` to receive
|
|
1272
|
+
* `system:localization` rows resolved against `Accept-Language`.
|
|
1273
|
+
*/
|
|
1274
|
+
getEntry(catalogName: string, entryName: string, locale?: string): Observable<CatalogEntry>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Get catalog entries with optional filtering and pagination (use cases 2 & 3).
|
|
1277
|
+
* By default only valid entries are returned. Pass `options.locale` to drive
|
|
1278
|
+
* `startswith(displayValue,'…')` matching and the localized response rows.
|
|
1279
|
+
*/
|
|
1280
|
+
getEntries(catalogName: string, options?: CatalogQueryOptions): Observable<CatalogResult>;
|
|
1281
|
+
/**
|
|
1282
|
+
* Autocomplete / filtered search (convenience wrapper for use case 3).
|
|
1283
|
+
* Searches the localized display value using startswith().
|
|
1284
|
+
*/
|
|
1285
|
+
autocomplete(catalogName: string, prefix: string, options?: CatalogQueryOptions): Observable<CatalogResult>;
|
|
1072
1286
|
static ɵfac: i0.ɵɵFactoryDeclaration<CatalogService, never>;
|
|
1073
1287
|
static ɵprov: i0.ɵɵInjectableDeclaration<CatalogService>;
|
|
1074
1288
|
}
|
|
@@ -1143,47 +1357,6 @@ declare class ClipboardService {
|
|
|
1143
1357
|
static ɵprov: i0.ɵɵInjectableDeclaration<ClipboardService>;
|
|
1144
1358
|
}
|
|
1145
1359
|
|
|
1146
|
-
/**
|
|
1147
|
-
* @ignore
|
|
1148
|
-
*/
|
|
1149
|
-
declare const CUSTOM_CONFIG: InjectionToken<CoreConfig>;
|
|
1150
|
-
declare const CORE_CONFIG: InjectionToken<CoreConfig>;
|
|
1151
|
-
|
|
1152
|
-
/**
|
|
1153
|
-
* Service to monitor the online/offline state of the application.
|
|
1154
|
-
* It listens to the browser's online and offline events and provides an observable
|
|
1155
|
-
* to track the current connection state.
|
|
1156
|
-
*
|
|
1157
|
-
* An observable `connection$` is provided which emits the current connection state
|
|
1158
|
-
* whenever the online or offline state changes. The initial state is determined by
|
|
1159
|
-
* the `window.navigator.onLine` property.
|
|
1160
|
-
*/
|
|
1161
|
-
declare class ConnectionService {
|
|
1162
|
-
private currentState;
|
|
1163
|
-
private connectionStateSource;
|
|
1164
|
-
connection$: Observable<ConnectionState>;
|
|
1165
|
-
/**
|
|
1166
|
-
* @ignore
|
|
1167
|
-
*/
|
|
1168
|
-
constructor();
|
|
1169
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<ConnectionService, never>;
|
|
1170
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<ConnectionService>;
|
|
1171
|
-
}
|
|
1172
|
-
/**
|
|
1173
|
-
* Check a connection state of a client
|
|
1174
|
-
*/
|
|
1175
|
-
interface ConnectionState {
|
|
1176
|
-
/**
|
|
1177
|
-
* whether or not the application is online.
|
|
1178
|
-
*/
|
|
1179
|
-
isOnline: boolean;
|
|
1180
|
-
}
|
|
1181
|
-
|
|
1182
|
-
/**
|
|
1183
|
-
* Providing functions,that are are injected at application startup and executed during app initialization.
|
|
1184
|
-
*/
|
|
1185
|
-
declare const init_moduleFnc: () => rxjs.Observable<boolean | _yuuvis_client_core.YuvUser | YuvConfig[]>;
|
|
1186
|
-
|
|
1187
1360
|
declare enum DeviceScreenOrientation {
|
|
1188
1361
|
PORTRAIT = "portrait",
|
|
1189
1362
|
LANDSCAPE = "landscape"
|
|
@@ -1684,6 +1857,41 @@ declare class IdmService {
|
|
|
1684
1857
|
static ɵprov: i0.ɵɵInjectableDeclaration<IdmService>;
|
|
1685
1858
|
}
|
|
1686
1859
|
|
|
1860
|
+
interface Localization {
|
|
1861
|
+
[key: string]: string;
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
/**
|
|
1865
|
+
* Service managing localizations. The localizations are fetched
|
|
1866
|
+
* during app initialization and stored in this service for
|
|
1867
|
+
* later use.
|
|
1868
|
+
*
|
|
1869
|
+
* Localizations could be extended by providing custom key-value pairs.
|
|
1870
|
+
*/
|
|
1871
|
+
declare class LocalizationService {
|
|
1872
|
+
#private;
|
|
1873
|
+
fetchLocalizations(): Observable<Localization>;
|
|
1874
|
+
getLocalizedResource(key: string): string;
|
|
1875
|
+
getLocalizedLabel(id: string): string;
|
|
1876
|
+
getLocalizedDescription(id: string): string;
|
|
1877
|
+
/**
|
|
1878
|
+
* Extend localizations with custom key-value pairs. This allows to add custom localizations without
|
|
1879
|
+
* modifying the localizations provided by the backend. The extension is applied
|
|
1880
|
+
* on top of the localizations fetched from the backend, so it can be used to override
|
|
1881
|
+
* existing localizations as well.
|
|
1882
|
+
* @param localizations Record of key-value pairs for localizations, where the key is the language
|
|
1883
|
+
* code (e.g. 'en', 'de', ...) and the value is a record of key-value pairs for localizations.
|
|
1884
|
+
* Example:
|
|
1885
|
+
* {
|
|
1886
|
+
* en: { 'key1': 'value1', 'key2': 'value2' },
|
|
1887
|
+
* de: { 'key1': 'wert1', 'key2': 'wert2' }
|
|
1888
|
+
* }
|
|
1889
|
+
*/
|
|
1890
|
+
extendLocalizations(localizations: Record<string, Localization>): void;
|
|
1891
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocalizationService, never>;
|
|
1892
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<LocalizationService>;
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1687
1895
|
/**
|
|
1688
1896
|
* Interface providing a default logger, that is used for the Dependency-Injection (DI) token.
|
|
1689
1897
|
*/
|
|
@@ -1796,6 +2004,8 @@ declare const SystemType: {
|
|
|
1796
2004
|
FOLDER: string;
|
|
1797
2005
|
AUDIT: string;
|
|
1798
2006
|
ITEM: string;
|
|
2007
|
+
CATALOG: string;
|
|
2008
|
+
CATALOG_ENTRY: string;
|
|
1799
2009
|
RELATIONSHIP: string;
|
|
1800
2010
|
SOT: string;
|
|
1801
2011
|
};
|
|
@@ -1822,6 +2032,16 @@ declare const RelationshipTypeField: {
|
|
|
1822
2032
|
SOURCE_ID: string;
|
|
1823
2033
|
TARGET_ID: string;
|
|
1824
2034
|
};
|
|
2035
|
+
declare const LockField: {
|
|
2036
|
+
LOCK_TAG: string;
|
|
2037
|
+
};
|
|
2038
|
+
declare const CatalogTypeField: {
|
|
2039
|
+
NATIVE_ID: string;
|
|
2040
|
+
CATALOG_NATIVE_ID: string;
|
|
2041
|
+
DATE_VALID_FROM: string;
|
|
2042
|
+
DATE_VALID_UNTIL: string;
|
|
2043
|
+
LOCALIZATION: string;
|
|
2044
|
+
};
|
|
1825
2045
|
declare const BaseObjectTypeField: {
|
|
1826
2046
|
PARENT_ID: string;
|
|
1827
2047
|
PARENT_OBJECT_TYPE_ID: string;
|
|
@@ -1880,8 +2100,6 @@ declare enum ContentStreamAllowed {
|
|
|
1880
2100
|
}
|
|
1881
2101
|
declare enum Classification {
|
|
1882
2102
|
STRING_CATALOG_I18N = "i18n:catalog",
|
|
1883
|
-
STRING_CATALOG_CUSTOM = "custom:catalog",
|
|
1884
|
-
STRING_CATALOG_DYNAMIC = "dynamic:catalog",
|
|
1885
2103
|
STRING_CATALOG = "catalog",
|
|
1886
2104
|
STRING_ORGANIZATION = "id:organization",
|
|
1887
2105
|
STRING_ORGANIZATION_SET = "id:organization:set",
|
|
@@ -1928,6 +2146,51 @@ declare const AFO_STATE: {
|
|
|
1928
2146
|
};
|
|
1929
2147
|
declare const ColumnConfigSkipFields: string[];
|
|
1930
2148
|
|
|
2149
|
+
type ObjectTypeFieldType = 'string' | 'integer' | 'decimal' | 'boolean' | 'table' | 'datetime';
|
|
2150
|
+
type ObjectTypeFieldInternalType = ObjectTypeFieldType | InternalFieldType.STRING_REFERENCE | InternalFieldType.STRING_ORGANIZATION | InternalFieldType.STRING_ORGANIZATION_SET | InternalFieldType.STRING_CATALOG | InternalFieldType.STRING_CATALOG_I18N | InternalFieldType.BOOLEAN_SWITCH | InternalFieldType.STRING_DYNAMIC_CATALOG;
|
|
2151
|
+
interface FormElementString extends ObjectTypeField {
|
|
2152
|
+
propertyType: 'string';
|
|
2153
|
+
defaultvalue?: string[] | string;
|
|
2154
|
+
maxLength?: number;
|
|
2155
|
+
minLength?: number;
|
|
2156
|
+
rows?: number;
|
|
2157
|
+
options?: string[] | string;
|
|
2158
|
+
regex?: string;
|
|
2159
|
+
}
|
|
2160
|
+
interface FormElementInteger extends ObjectTypeField {
|
|
2161
|
+
propertyType: 'integer';
|
|
2162
|
+
defaultvalue?: number[] | number;
|
|
2163
|
+
maxValue?: number;
|
|
2164
|
+
minValue?: number;
|
|
2165
|
+
precision?: number;
|
|
2166
|
+
grouping?: boolean;
|
|
2167
|
+
pattern?: string;
|
|
2168
|
+
}
|
|
2169
|
+
interface FormElementDecimal extends ObjectTypeField {
|
|
2170
|
+
propertyType: 'decimal';
|
|
2171
|
+
defaultvalue?: number[] | number;
|
|
2172
|
+
maxValue?: number;
|
|
2173
|
+
minValue?: number;
|
|
2174
|
+
precision?: number;
|
|
2175
|
+
scale?: number;
|
|
2176
|
+
grouping?: boolean;
|
|
2177
|
+
pattern?: string;
|
|
2178
|
+
}
|
|
2179
|
+
interface FormElementBoolean extends ObjectTypeField {
|
|
2180
|
+
propertyType: 'boolean';
|
|
2181
|
+
defaultvalue?: boolean;
|
|
2182
|
+
tristate?: boolean;
|
|
2183
|
+
}
|
|
2184
|
+
interface FormElementDatetime extends ObjectTypeField {
|
|
2185
|
+
propertyType: 'datetime';
|
|
2186
|
+
defaultvalue?: string[] | string;
|
|
2187
|
+
resolution?: 'date';
|
|
2188
|
+
}
|
|
2189
|
+
interface FormElementTable extends ObjectTypeField {
|
|
2190
|
+
elements: ObjectTypeField[];
|
|
2191
|
+
propertyType: 'table';
|
|
2192
|
+
}
|
|
2193
|
+
|
|
1931
2194
|
/**
|
|
1932
2195
|
* Virtual object types.
|
|
1933
2196
|
* They are a combination of an object type ID and/or a list of SOTs
|
|
@@ -1947,7 +2210,6 @@ interface SystemDefinition {
|
|
|
1947
2210
|
objectTypes: ObjectType[];
|
|
1948
2211
|
secondaryObjectTypes: SecondaryObjectType[];
|
|
1949
2212
|
relationships: Relationship[];
|
|
1950
|
-
i18n: Localization;
|
|
1951
2213
|
allFields: Record<string, SchemaResponseFieldDefinition>;
|
|
1952
2214
|
}
|
|
1953
2215
|
interface GenericObjectType extends ObjectType {
|
|
@@ -1995,6 +2257,7 @@ interface _ObjectTypeFieldBase {
|
|
|
1995
2257
|
queryable?: boolean;
|
|
1996
2258
|
classifications?: string[];
|
|
1997
2259
|
resolution?: string;
|
|
2260
|
+
catalog?: string;
|
|
1998
2261
|
columnDefinitions?: SchemaResponseFieldDefinition[];
|
|
1999
2262
|
}
|
|
2000
2263
|
/**
|
|
@@ -2009,10 +2272,6 @@ interface ObjectTypeField extends _ObjectTypeFieldBase {
|
|
|
2009
2272
|
_internalType: ObjectTypeFieldInternalType;
|
|
2010
2273
|
label?: string;
|
|
2011
2274
|
}
|
|
2012
|
-
interface VisibleObjectTag {
|
|
2013
|
-
tagName: string;
|
|
2014
|
-
tagValues?: unknown[];
|
|
2015
|
-
}
|
|
2016
2275
|
/**
|
|
2017
2276
|
* Base definition of the kind of data we'll receive
|
|
2018
2277
|
* from the backend asking for native schema
|
|
@@ -2074,9 +2333,6 @@ interface ApplicableSecondaries {
|
|
|
2074
2333
|
primarySOTs: SecondaryObjectType[];
|
|
2075
2334
|
extendingSOTs: SecondaryObjectType[];
|
|
2076
2335
|
}
|
|
2077
|
-
interface Localization {
|
|
2078
|
-
[key: string]: string;
|
|
2079
|
-
}
|
|
2080
2336
|
interface UserPermissions {
|
|
2081
2337
|
create: UserPermissionsSection;
|
|
2082
2338
|
read: UserPermissionsSection;
|
|
@@ -2093,51 +2349,6 @@ interface ObjectTypePermissions {
|
|
|
2093
2349
|
searchableObjectTypes: string[];
|
|
2094
2350
|
}
|
|
2095
2351
|
|
|
2096
|
-
type ObjectTypeFieldType = 'string' | 'integer' | 'decimal' | 'boolean' | 'table' | 'datetime';
|
|
2097
|
-
type ObjectTypeFieldInternalType = ObjectTypeFieldType | InternalFieldType.STRING_REFERENCE | InternalFieldType.STRING_ORGANIZATION | InternalFieldType.STRING_ORGANIZATION_SET | InternalFieldType.STRING_CATALOG | InternalFieldType.STRING_CATALOG_I18N | InternalFieldType.BOOLEAN_SWITCH | InternalFieldType.STRING_DYNAMIC_CATALOG;
|
|
2098
|
-
interface FormElementString extends ObjectTypeField {
|
|
2099
|
-
propertyType: 'string';
|
|
2100
|
-
defaultvalue?: string[] | string;
|
|
2101
|
-
maxLength?: number;
|
|
2102
|
-
minLength?: number;
|
|
2103
|
-
rows?: number;
|
|
2104
|
-
options?: string[] | string;
|
|
2105
|
-
regex?: string;
|
|
2106
|
-
}
|
|
2107
|
-
interface FormElementInteger extends ObjectTypeField {
|
|
2108
|
-
propertyType: 'integer';
|
|
2109
|
-
defaultvalue?: number[] | number;
|
|
2110
|
-
maxValue?: number;
|
|
2111
|
-
minValue?: number;
|
|
2112
|
-
precision?: number;
|
|
2113
|
-
grouping?: boolean;
|
|
2114
|
-
pattern?: string;
|
|
2115
|
-
}
|
|
2116
|
-
interface FormElementDecimal extends ObjectTypeField {
|
|
2117
|
-
propertyType: 'decimal';
|
|
2118
|
-
defaultvalue?: number[] | number;
|
|
2119
|
-
maxValue?: number;
|
|
2120
|
-
minValue?: number;
|
|
2121
|
-
precision?: number;
|
|
2122
|
-
scale?: number;
|
|
2123
|
-
grouping?: boolean;
|
|
2124
|
-
pattern?: string;
|
|
2125
|
-
}
|
|
2126
|
-
interface FormElementBoolean extends ObjectTypeField {
|
|
2127
|
-
propertyType: 'boolean';
|
|
2128
|
-
defaultvalue?: boolean;
|
|
2129
|
-
tristate?: boolean;
|
|
2130
|
-
}
|
|
2131
|
-
interface FormElementDatetime extends ObjectTypeField {
|
|
2132
|
-
propertyType: 'datetime';
|
|
2133
|
-
defaultvalue?: string[] | string;
|
|
2134
|
-
resolution?: 'date';
|
|
2135
|
-
}
|
|
2136
|
-
interface FormElementTable extends ObjectTypeField {
|
|
2137
|
-
elements: ObjectTypeField[];
|
|
2138
|
-
propertyType: 'table';
|
|
2139
|
-
}
|
|
2140
|
-
|
|
2141
2352
|
/**
|
|
2142
2353
|
* Config defining the most important/interessting fields for
|
|
2143
2354
|
* a certain object type. They'll be used to render result lists
|
|
@@ -2160,7 +2371,7 @@ interface ObjectConfigAction {
|
|
|
2160
2371
|
id: string;
|
|
2161
2372
|
}
|
|
2162
2373
|
interface ObjectConfigBadge {
|
|
2163
|
-
|
|
2374
|
+
id: string;
|
|
2164
2375
|
}
|
|
2165
2376
|
interface ObjectConfigProperty {
|
|
2166
2377
|
label: string;
|
|
@@ -2281,6 +2492,75 @@ declare class ObjectFormControl extends FormControl {
|
|
|
2281
2492
|
get _eoFormElement(): any;
|
|
2282
2493
|
}
|
|
2283
2494
|
|
|
2495
|
+
declare const LOCK_TAG_OWNER_INDEX = 4;
|
|
2496
|
+
declare function findLockTag<T extends unknown[] = (string | number)[]>(dmsObject: DmsObject): T | undefined;
|
|
2497
|
+
|
|
2498
|
+
interface LockOptions {
|
|
2499
|
+
/** Tag identifier used to mark the object as locked. Defaults to `LockField.LOCK_TAG`. */
|
|
2500
|
+
lockTag?: string;
|
|
2501
|
+
/** Lock state value forwarded to the backend as part of the tag path. */
|
|
2502
|
+
state: number;
|
|
2503
|
+
/** Whether to overwrite an existing lock tag on the object. */
|
|
2504
|
+
override: boolean;
|
|
2505
|
+
/** Whether to include the objects in the response. */
|
|
2506
|
+
includeObjects: boolean;
|
|
2507
|
+
}
|
|
2508
|
+
declare const DEFAULT_LOCK_OPTIONS: LockOptions;
|
|
2509
|
+
/**
|
|
2510
|
+
* Response payload returned by the lock endpoint. Contains the updated tag rows
|
|
2511
|
+
* of the affected object under `LockField.LOCK_TAG`.
|
|
2512
|
+
*/
|
|
2513
|
+
interface ObjectLockingResponse {
|
|
2514
|
+
objects: {
|
|
2515
|
+
properties: {
|
|
2516
|
+
'system:tags': {
|
|
2517
|
+
value: (number | string)[][];
|
|
2518
|
+
columnNames: string[];
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
}[];
|
|
2522
|
+
}
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* Snapshot of a DMS object's lock state relative to the current user.
|
|
2526
|
+
*/
|
|
2527
|
+
interface LockState {
|
|
2528
|
+
/** Whether a lock tag is present on the object. */
|
|
2529
|
+
locked: boolean;
|
|
2530
|
+
/** Whether the lock is held by the currently authenticated user. */
|
|
2531
|
+
lockedByCurrentUser: boolean;
|
|
2532
|
+
/** ID of the user holding the lock, when one is present. */
|
|
2533
|
+
ownerId?: string;
|
|
2534
|
+
}
|
|
2535
|
+
/**
|
|
2536
|
+
* Service to lock and unlock DMS objects via the backend tag API.
|
|
2537
|
+
*/
|
|
2538
|
+
declare class ObjectLockingService {
|
|
2539
|
+
#private;
|
|
2540
|
+
/**
|
|
2541
|
+
* Lock a DMS object by setting a lock tag with a given state.
|
|
2542
|
+
* @param id ID of the object to lock
|
|
2543
|
+
* @returns Observable emitting the updated tag data of the locked object
|
|
2544
|
+
* @see {@link ObjectLockingResponse}
|
|
2545
|
+
*/
|
|
2546
|
+
lock(id: string): Observable<ObjectLockingResponse>;
|
|
2547
|
+
/**
|
|
2548
|
+
* Remove the lock tag from a DMS object.
|
|
2549
|
+
* @param id ID of the object to unlock
|
|
2550
|
+
* @param lockTag Tag identifier to remove; defaults to `LockField.LOCK_TAG`
|
|
2551
|
+
* @returns Observable that completes once the tag has been deleted
|
|
2552
|
+
*/
|
|
2553
|
+
unlock(id: string, lockTag?: string): Observable<void>;
|
|
2554
|
+
/**
|
|
2555
|
+
* Inspect the lock state of a DMS object relative to the current user.
|
|
2556
|
+
* @param dmsObject Object to inspect
|
|
2557
|
+
* @returns `locked` flag, whether the current user is the lock owner, and the owner id when present.
|
|
2558
|
+
*/
|
|
2559
|
+
getLockState(dmsObject: DmsObject): LockState;
|
|
2560
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ObjectLockingService, never>;
|
|
2561
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ObjectLockingService>;
|
|
2562
|
+
}
|
|
2563
|
+
|
|
2284
2564
|
/**
|
|
2285
2565
|
* Interface to be implemented by all components (state components) that are aware of pending changes
|
|
2286
2566
|
*/
|
|
@@ -2691,36 +2971,12 @@ declare class SystemService {
|
|
|
2691
2971
|
id: string;
|
|
2692
2972
|
fields: ObjectTypeField[];
|
|
2693
2973
|
};
|
|
2694
|
-
/**
|
|
2695
|
-
* Get the resolved object tags
|
|
2696
|
-
*/
|
|
2697
|
-
getResolvedTags(objectTypeId: string): {
|
|
2698
|
-
id: string;
|
|
2699
|
-
tagName: string;
|
|
2700
|
-
tagValues: any;
|
|
2701
|
-
fields: ObjectTypeField[];
|
|
2702
|
-
}[];
|
|
2703
2974
|
/**
|
|
2704
2975
|
* Get a list of classifications for a given object type including the
|
|
2705
2976
|
* classifications of its static secondary object types
|
|
2706
2977
|
* @param objectTypeId ID of the object type
|
|
2707
2978
|
*/
|
|
2708
2979
|
getResolvedClassifications(objectTypeId: string): string[];
|
|
2709
|
-
/**
|
|
2710
|
-
* Visible tags are defined by a classification on the object type (e.g. 'tag[tenkolibri:process,1,2,3]').
|
|
2711
|
-
*
|
|
2712
|
-
* The example will only return tags with the name 'tenkolibri:process'
|
|
2713
|
-
* and values of either 1, 2 or 3. All other tags will be ignored.
|
|
2714
|
-
*
|
|
2715
|
-
* @param objectTypeId ID of the object type to get the visible tags for
|
|
2716
|
-
* @returns object where the property name is the name of the tag and its value are the visible values
|
|
2717
|
-
* for that tag (if values is emoty all values are allowed)
|
|
2718
|
-
*/
|
|
2719
|
-
getVisibleTags(objectTypeId: string): {
|
|
2720
|
-
[tagName: string]: any[];
|
|
2721
|
-
};
|
|
2722
|
-
private fetchVisibleTags;
|
|
2723
|
-
filterVisibleTags(objectTypeId: string, tagsValue: Array<Array<any>>): Array<Array<any>>;
|
|
2724
2980
|
/**
|
|
2725
2981
|
* Get the icon for an object type. This will return an SVG as a string.
|
|
2726
2982
|
* @param objectTypeId ID of the object type
|
|
@@ -2733,9 +2989,17 @@ declare class SystemService {
|
|
|
2733
2989
|
* @param fallback ID of a fallback icon that should be used if the given object type has no icon yet
|
|
2734
2990
|
*/
|
|
2735
2991
|
getObjectTypeIconUri(objectTypeId: string, fallback?: string): string;
|
|
2736
|
-
|
|
2992
|
+
/**
|
|
2993
|
+
* @deprecated use LocalizationService.getLocalizedResource instead
|
|
2994
|
+
*/
|
|
2737
2995
|
getLocalizedResource(key: string): string;
|
|
2996
|
+
/**
|
|
2997
|
+
* @deprecated use LocalizationService.getLocalizedResource instead
|
|
2998
|
+
*/
|
|
2738
2999
|
getLocalizedLabel(id: string): string;
|
|
3000
|
+
/**
|
|
3001
|
+
* @deprecated use LocalizationService.getLocalizedResource instead
|
|
3002
|
+
*/
|
|
2739
3003
|
getLocalizedDescription(id: string): string;
|
|
2740
3004
|
/**
|
|
2741
3005
|
* Determine whether or not the given object type field is a system field
|
|
@@ -2750,19 +3014,19 @@ declare class SystemService {
|
|
|
2750
3014
|
* @param user The user to load the system definition for
|
|
2751
3015
|
*/
|
|
2752
3016
|
getSystemDefinition(authData?: AuthData): Observable<boolean>;
|
|
2753
|
-
setPermissions(
|
|
3017
|
+
setPermissions(permissions: ObjectTypePermissions): void;
|
|
2754
3018
|
/**
|
|
2755
3019
|
* Create the schema from the servers schema response
|
|
2756
3020
|
* @param schemaResponse Response from the backend
|
|
2757
3021
|
*/
|
|
2758
|
-
setSchema(schemaResponse: SchemaResponse
|
|
3022
|
+
setSchema(schemaResponse: SchemaResponse): void;
|
|
2759
3023
|
/**
|
|
2760
3024
|
* Fetch a collection of form models.
|
|
2761
3025
|
* @param objectTypeIDs Object type IDs to fetch form model for
|
|
2762
3026
|
* @param situation Form situation
|
|
2763
3027
|
* @returns Object where the object type id is key and the form model is the value
|
|
2764
3028
|
*/
|
|
2765
|
-
getObjectTypeForms(objectTypeIDs: string[], situation: string): Observable<Record<string,
|
|
3029
|
+
getObjectTypeForms(objectTypeIDs: string[], situation: string): Observable<Record<string, unknown>>;
|
|
2766
3030
|
/**
|
|
2767
3031
|
* Get the form model of an object type.
|
|
2768
3032
|
*
|
|
@@ -2770,7 +3034,7 @@ declare class SystemService {
|
|
|
2770
3034
|
* @param situation The form situation to be fetched
|
|
2771
3035
|
* @returns Form model
|
|
2772
3036
|
*/
|
|
2773
|
-
getObjectTypeForm(objectTypeId: string, situation: string): Observable<
|
|
3037
|
+
getObjectTypeForm(objectTypeId: string, situation: string): Observable<unknown>;
|
|
2774
3038
|
/**
|
|
2775
3039
|
* Generates an internal type for a given object type field.
|
|
2776
3040
|
* Adding this to a form element or object type field enables us to render forms
|
|
@@ -2778,8 +3042,9 @@ declare class SystemService {
|
|
|
2778
3042
|
* have to evaluate the conditions for every form element on every digest cycle.
|
|
2779
3043
|
* @param type propertyType of the ObjectTypeField
|
|
2780
3044
|
* @param classifications classifications of the ObjectTypeField
|
|
3045
|
+
* @param catalog catalog reference of the ObjectTypeField
|
|
2781
3046
|
*/
|
|
2782
|
-
getInternalFormElementType(type: string, classifications?: string[]): ObjectTypeFieldInternalType;
|
|
3047
|
+
getInternalFormElementType(type: string, classifications?: string[], catalog?: string): ObjectTypeFieldInternalType;
|
|
2783
3048
|
getObjectTypeField(id: string): ObjectTypeField | undefined;
|
|
2784
3049
|
/**
|
|
2785
3050
|
* Extract classifications from object type fields classification
|
|
@@ -2793,12 +3058,11 @@ declare class SystemService {
|
|
|
2793
3058
|
* @param classifications Object type fields classification property (schema)
|
|
2794
3059
|
*/
|
|
2795
3060
|
getClassifications(classifications: string[]): Map<string, ClassificationEntry>;
|
|
2796
|
-
toFormElement(field: ObjectTypeField):
|
|
3061
|
+
toFormElement(field: ObjectTypeField): unknown;
|
|
2797
3062
|
updateAuthData(data: Partial<AuthData>): Observable<boolean>;
|
|
2798
|
-
updateLocalizations(iso: string): Observable<any>;
|
|
2799
3063
|
fetchResources(id: string): Observable<{
|
|
2800
|
-
global:
|
|
2801
|
-
tenant:
|
|
3064
|
+
global: unknown;
|
|
3065
|
+
tenant: unknown;
|
|
2802
3066
|
}>;
|
|
2803
3067
|
static ɵfac: i0.ɵɵFactoryDeclaration<SystemService, never>;
|
|
2804
3068
|
static ɵprov: i0.ɵɵInjectableDeclaration<SystemService>;
|
|
@@ -3066,20 +3330,10 @@ declare const provideUser: (user: YuvUser) => Provider;
|
|
|
3066
3330
|
*/
|
|
3067
3331
|
declare class UserService {
|
|
3068
3332
|
#private;
|
|
3069
|
-
private backend;
|
|
3070
|
-
private translate;
|
|
3071
|
-
private logger;
|
|
3072
|
-
private system;
|
|
3073
|
-
private eventService;
|
|
3074
|
-
private config;
|
|
3075
3333
|
user$: Observable<YuvUser | undefined>;
|
|
3076
3334
|
globalSettings: Map<any, any>;
|
|
3077
3335
|
userPermissions?: UserPermissions;
|
|
3078
|
-
|
|
3079
|
-
* @ignore
|
|
3080
|
-
*/
|
|
3081
|
-
constructor(backend: BackendService, translate: TranslateService, logger: Logger, system: SystemService, eventService: EventService, config: ConfigService);
|
|
3082
|
-
private getUiDirection;
|
|
3336
|
+
canCreateObjects: boolean;
|
|
3083
3337
|
/**
|
|
3084
3338
|
* Set a new current user
|
|
3085
3339
|
* @param user The user to be set as current user
|
|
@@ -3092,7 +3346,6 @@ declare class UserService {
|
|
|
3092
3346
|
get hasManageSettingsRole(): boolean;
|
|
3093
3347
|
get isAdvancedUser(): boolean;
|
|
3094
3348
|
get isRetentionManager(): boolean;
|
|
3095
|
-
canCreateObjects: boolean;
|
|
3096
3349
|
/**
|
|
3097
3350
|
* Change the users client locale
|
|
3098
3351
|
* @param iso ISO locale string to be set as new client locale
|
|
@@ -3100,8 +3353,6 @@ declare class UserService {
|
|
|
3100
3353
|
changeClientLocale(iso: string, persist?: boolean): void;
|
|
3101
3354
|
saveUserSettings(settings: Partial<UserSettings>): Observable<any>;
|
|
3102
3355
|
fetchUserSettings(): Observable<UserSettings>;
|
|
3103
|
-
private setUserPermissions;
|
|
3104
|
-
private mapPermissions;
|
|
3105
3356
|
/**
|
|
3106
3357
|
* Search for a user based on a search term
|
|
3107
3358
|
* @param term Search term
|
|
@@ -3416,5 +3667,5 @@ interface YuvClientCoreConfig {
|
|
|
3416
3667
|
}
|
|
3417
3668
|
declare const provideYuvClientCore: (options?: YuvClientCoreConfig, customEvents?: string[], customEventsTrustedOrigin?: string[], disableBeforeUnloadProtection?: boolean, disablePopstateDialogProtection?: boolean) => EnvironmentProviders;
|
|
3418
3669
|
|
|
3419
|
-
export { AFO_STATE, AVAILABLE_BACKEND_APPS, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthService, BackendService, BaseObjectTypeField, BpmService, CLIENT_APP_REQUIREMENTS, CORE_CONFIG, CUSTOM_CONFIG, CUSTOM_YUV_EVENT_PREFIX, CatalogService, Classification, ClassificationPrefix, ClientCacheService, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, TabGuardDirective, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, init_moduleFnc, provideAvailabilityManagement, provideBeforeUnloadProtection, provideNavigationProtection, providePopstateDialogProtection, provideRequirements, provideUser, provideYuvClientCore };
|
|
3420
|
-
export type { AggregateResult, Aggregation, AggregationEntry, ApplicableSecondaries, AuditEntry, AuditQueryOptions, AuditQueryResult, AuthData, AvailabilityState,
|
|
3670
|
+
export { AFO_STATE, AVAILABLE_BACKEND_APPS, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthInterceptorFnc, AuthService, BackendService, BaseObjectTypeField, BpmService, CLIENT_APP_REQUIREMENTS, CORE_CONFIG, CUSTOM_CONFIG, CUSTOM_YUV_EVENT_PREFIX, CatalogService, CatalogTypeField, Classification, ClassificationPrefix, ClientCacheService, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DEFAULT_LOCK_OPTIONS, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EoxMissingTranslationHandler, EoxTranslateJsonLoader, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LOCALIZATION_COLUMNS, LOCK_TAG_OWNER_INDEX, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, LocalizationService, LockField, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectLockingService, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, OfflineInterceptorFnc, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, TabGuardDirective, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, findLockTag, init_moduleFnc, provideAvailabilityManagement, provideBeforeUnloadProtection, provideNavigationProtection, providePopstateDialogProtection, provideRequirements, provideUser, provideYuvClientCore };
|
|
3671
|
+
export type { AggregateResult, Aggregation, AggregationEntry, ApplicableSecondaries, AuditEntry, AuditQueryOptions, AuditQueryResult, AuthData, AvailabilityState, CacheEntry, Catalog, CatalogApiObject, CatalogApiPropertyValue, CatalogApiResponse, CatalogEntry, CatalogEntryCreatePayload, CatalogEntryUpdatePayload, CatalogLocalization, CatalogLocalizationPayload, CatalogPayload, CatalogPropertyFilter, CatalogQueryOptions, CatalogResult, ClassificationEntry, ClipboardData, ClipboardDataMode, ClipboardStore, ConfigTypeOption, ConnectionState, ContentStream$1 as ContentStream, CoreApiBatchResponse, CoreApiObject, CoreApiObjectProperty, CoreApiResponse, CreatedObject, DateRange, DeviceScreen, DeviceScreenBounds, DmsObjectAuditInfo, DmsObjectPermissions, DmsObjectTag, FetchTaskOptions, FilesizeRange, FlavoredDmsObject, FormElementBoolean, FormElementDatetime, FormElementDecimal, FormElementInteger, FormElementString, FormElementTable, FormattedMailTo, GenericObjectType, HttpDeleteOptions, HttpOptions, ILogger, IdmCachedUser, IdmUserCache, IdmUserResponse, InboxTask, IsAny, LockOptions, LockState, LoginDeviceResult, LoginState, ObjectConfig, ObjectConfigAction, ObjectConfigBadge, ObjectConfigBucket, ObjectConfigIcon, ObjectConfigProperty, ObjectConfigRecord, ObjectCopyOptions, ObjectCreateFlavor, ObjectDeleteError, ObjectDeleteOptions, ObjectDeleteResult, ObjectFormModel, ObjectLockingResponse, ObjectMoveOptions, ObjectOptions, ObjectType, ObjectTypeField, ObjectTypeFieldInternalType, ObjectTypeFieldType, ObjectTypeFlavor, ObjectTypePermissions, OrganizationSetEntry, PredictionClassifyResult, PredictionClassifyResultItem, PredictionExtractResult, PredictionExtractResultItem, Process, ProcessCreatePayload, ProcessPostPayload, ProcessUser, ProcessVariable, ProgressStatus, ProgressStatusItem, RangeValue, Relationship, RendererType, Requirements, ResolvedObjectConfig, ResolvedObjectConfigItem, RetentionState, SchemaResponse, SchemaResponseDocumentTypeDefinition, SchemaResponseFieldDefinition, SchemaResponseFolderTypeDefinition, SchemaResponseRelationDefinition, SchemaResponseTypeDefinition, ScreenSize, SearchFilter, SearchQuery, SearchResponse, SearchResult, SearchResultContent, SearchResultItem, SearchResultPermissions, SecondaryObjectType, SortOption, StoredObjectConfig, StoredToken, SystemDefinition, TableFilter, ToastLevel, ToastOptions, ToastPosition, Trigger, UploadResult, UserPermissions, UserPermissionsSection, UserSettings, VirtualObjectType, YuvAvailableBackendApps, YuvClientCoreConfig, YuvConfig, YuvConfigLanguages, YuvEvent, YuvEventCreatedData, YuvEventDeletedData, YuvEventUpdatedData, YuvFormGroup, YuvFormGroupWrapper, YuvInitError, YuvMessage, _ObjectTypeBase, _ObjectTypeFieldBase };
|