@yuuvis/client-core 3.1.0 → 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 +1396 -1327
- package/fesm2022/yuuvis-client-core.mjs.map +1 -1
- package/package.json +1 -1
- package/types/yuuvis-client-core.d.ts +312 -201
package/package.json
CHANGED
|
@@ -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
|
|
509
|
-
*/
|
|
510
|
-
interface AuditQueryResult {
|
|
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.
|
|
492
|
+
* Prevent app from running into 401 issues related to gateway timeouts.
|
|
544
493
|
*/
|
|
545
|
-
declare
|
|
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
|
*
|
|
@@ -1277,47 +1357,6 @@ declare class ClipboardService {
|
|
|
1277
1357
|
static ɵprov: i0.ɵɵInjectableDeclaration<ClipboardService>;
|
|
1278
1358
|
}
|
|
1279
1359
|
|
|
1280
|
-
/**
|
|
1281
|
-
* @ignore
|
|
1282
|
-
*/
|
|
1283
|
-
declare const CUSTOM_CONFIG: InjectionToken<CoreConfig>;
|
|
1284
|
-
declare const CORE_CONFIG: InjectionToken<CoreConfig>;
|
|
1285
|
-
|
|
1286
|
-
/**
|
|
1287
|
-
* Service to monitor the online/offline state of the application.
|
|
1288
|
-
* It listens to the browser's online and offline events and provides an observable
|
|
1289
|
-
* to track the current connection state.
|
|
1290
|
-
*
|
|
1291
|
-
* An observable `connection$` is provided which emits the current connection state
|
|
1292
|
-
* whenever the online or offline state changes. The initial state is determined by
|
|
1293
|
-
* the `window.navigator.onLine` property.
|
|
1294
|
-
*/
|
|
1295
|
-
declare class ConnectionService {
|
|
1296
|
-
private currentState;
|
|
1297
|
-
private connectionStateSource;
|
|
1298
|
-
connection$: Observable<ConnectionState>;
|
|
1299
|
-
/**
|
|
1300
|
-
* @ignore
|
|
1301
|
-
*/
|
|
1302
|
-
constructor();
|
|
1303
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<ConnectionService, never>;
|
|
1304
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<ConnectionService>;
|
|
1305
|
-
}
|
|
1306
|
-
/**
|
|
1307
|
-
* Check a connection state of a client
|
|
1308
|
-
*/
|
|
1309
|
-
interface ConnectionState {
|
|
1310
|
-
/**
|
|
1311
|
-
* whether or not the application is online.
|
|
1312
|
-
*/
|
|
1313
|
-
isOnline: boolean;
|
|
1314
|
-
}
|
|
1315
|
-
|
|
1316
|
-
/**
|
|
1317
|
-
* Providing functions,that are are injected at application startup and executed during app initialization.
|
|
1318
|
-
*/
|
|
1319
|
-
declare const init_moduleFnc: () => rxjs.Observable<boolean | _yuuvis_client_core.YuvUser | YuvConfig[]>;
|
|
1320
|
-
|
|
1321
1360
|
declare enum DeviceScreenOrientation {
|
|
1322
1361
|
PORTRAIT = "portrait",
|
|
1323
1362
|
LANDSCAPE = "landscape"
|
|
@@ -1993,6 +2032,9 @@ declare const RelationshipTypeField: {
|
|
|
1993
2032
|
SOURCE_ID: string;
|
|
1994
2033
|
TARGET_ID: string;
|
|
1995
2034
|
};
|
|
2035
|
+
declare const LockField: {
|
|
2036
|
+
LOCK_TAG: string;
|
|
2037
|
+
};
|
|
1996
2038
|
declare const CatalogTypeField: {
|
|
1997
2039
|
NATIVE_ID: string;
|
|
1998
2040
|
CATALOG_NATIVE_ID: string;
|
|
@@ -2104,6 +2146,51 @@ declare const AFO_STATE: {
|
|
|
2104
2146
|
};
|
|
2105
2147
|
declare const ColumnConfigSkipFields: string[];
|
|
2106
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
|
+
|
|
2107
2194
|
/**
|
|
2108
2195
|
* Virtual object types.
|
|
2109
2196
|
* They are a combination of an object type ID and/or a list of SOTs
|
|
@@ -2262,51 +2349,6 @@ interface ObjectTypePermissions {
|
|
|
2262
2349
|
searchableObjectTypes: string[];
|
|
2263
2350
|
}
|
|
2264
2351
|
|
|
2265
|
-
type ObjectTypeFieldType = 'string' | 'integer' | 'decimal' | 'boolean' | 'table' | 'datetime';
|
|
2266
|
-
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;
|
|
2267
|
-
interface FormElementString extends ObjectTypeField {
|
|
2268
|
-
propertyType: 'string';
|
|
2269
|
-
defaultvalue?: string[] | string;
|
|
2270
|
-
maxLength?: number;
|
|
2271
|
-
minLength?: number;
|
|
2272
|
-
rows?: number;
|
|
2273
|
-
options?: string[] | string;
|
|
2274
|
-
regex?: string;
|
|
2275
|
-
}
|
|
2276
|
-
interface FormElementInteger extends ObjectTypeField {
|
|
2277
|
-
propertyType: 'integer';
|
|
2278
|
-
defaultvalue?: number[] | number;
|
|
2279
|
-
maxValue?: number;
|
|
2280
|
-
minValue?: number;
|
|
2281
|
-
precision?: number;
|
|
2282
|
-
grouping?: boolean;
|
|
2283
|
-
pattern?: string;
|
|
2284
|
-
}
|
|
2285
|
-
interface FormElementDecimal extends ObjectTypeField {
|
|
2286
|
-
propertyType: 'decimal';
|
|
2287
|
-
defaultvalue?: number[] | number;
|
|
2288
|
-
maxValue?: number;
|
|
2289
|
-
minValue?: number;
|
|
2290
|
-
precision?: number;
|
|
2291
|
-
scale?: number;
|
|
2292
|
-
grouping?: boolean;
|
|
2293
|
-
pattern?: string;
|
|
2294
|
-
}
|
|
2295
|
-
interface FormElementBoolean extends ObjectTypeField {
|
|
2296
|
-
propertyType: 'boolean';
|
|
2297
|
-
defaultvalue?: boolean;
|
|
2298
|
-
tristate?: boolean;
|
|
2299
|
-
}
|
|
2300
|
-
interface FormElementDatetime extends ObjectTypeField {
|
|
2301
|
-
propertyType: 'datetime';
|
|
2302
|
-
defaultvalue?: string[] | string;
|
|
2303
|
-
resolution?: 'date';
|
|
2304
|
-
}
|
|
2305
|
-
interface FormElementTable extends ObjectTypeField {
|
|
2306
|
-
elements: ObjectTypeField[];
|
|
2307
|
-
propertyType: 'table';
|
|
2308
|
-
}
|
|
2309
|
-
|
|
2310
2352
|
/**
|
|
2311
2353
|
* Config defining the most important/interessting fields for
|
|
2312
2354
|
* a certain object type. They'll be used to render result lists
|
|
@@ -2329,7 +2371,7 @@ interface ObjectConfigAction {
|
|
|
2329
2371
|
id: string;
|
|
2330
2372
|
}
|
|
2331
2373
|
interface ObjectConfigBadge {
|
|
2332
|
-
|
|
2374
|
+
id: string;
|
|
2333
2375
|
}
|
|
2334
2376
|
interface ObjectConfigProperty {
|
|
2335
2377
|
label: string;
|
|
@@ -2450,6 +2492,75 @@ declare class ObjectFormControl extends FormControl {
|
|
|
2450
2492
|
get _eoFormElement(): any;
|
|
2451
2493
|
}
|
|
2452
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
|
+
|
|
2453
2564
|
/**
|
|
2454
2565
|
* Interface to be implemented by all components (state components) that are aware of pending changes
|
|
2455
2566
|
*/
|
|
@@ -3556,5 +3667,5 @@ interface YuvClientCoreConfig {
|
|
|
3556
3667
|
}
|
|
3557
3668
|
declare const provideYuvClientCore: (options?: YuvClientCoreConfig, customEvents?: string[], customEventsTrustedOrigin?: string[], disableBeforeUnloadProtection?: boolean, disablePopstateDialogProtection?: boolean) => EnvironmentProviders;
|
|
3558
3669
|
|
|
3559
|
-
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, CatalogTypeField, Classification, ClassificationPrefix, ClientCacheService, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LOCALIZATION_COLUMNS, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, LocalizationService, 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 };
|
|
3560
|
-
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,
|
|
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 };
|