@yuuvis/client-core 2.20.0 → 3.0.0-beta.20.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.
Files changed (102) hide show
  1. package/fesm2022/yuuvis-client-core.mjs +173 -169
  2. package/fesm2022/yuuvis-client-core.mjs.map +1 -1
  3. package/index.d.ts +3255 -68
  4. package/package.json +6 -6
  5. package/lib/common/pipes/filesize.pipe.d.ts +0 -18
  6. package/lib/common/pipes/index.d.ts +0 -5
  7. package/lib/common/pipes/keys.pipe.d.ts +0 -10
  8. package/lib/common/pipes/locale-date.pipe.d.ts +0 -12
  9. package/lib/common/pipes/locale-number.pipe.d.ts +0 -47
  10. package/lib/common/pipes/safe-html.pipe.d.ts +0 -28
  11. package/lib/common/services/native-notifications.d.ts +0 -8
  12. package/lib/common/services/native-notifications.interface.d.ts +0 -5
  13. package/lib/model/dms-object.interface.d.ts +0 -22
  14. package/lib/model/dms-object.model.d.ts +0 -26
  15. package/lib/model/file-upload-options.model.d.ts +0 -5
  16. package/lib/model/object-flavor.interface.d.ts +0 -46
  17. package/lib/model/range-value.interface.d.ts +0 -9
  18. package/lib/model/yuv-error.model.d.ts +0 -18
  19. package/lib/model/yuv-user.model.d.ts +0 -42
  20. package/lib/provider/available-backend-apps/available-backend-apps.model.d.ts +0 -6
  21. package/lib/provider/available-backend-apps/available-backend-apps.provider.d.ts +0 -6
  22. package/lib/provider/available-backend-apps/index.d.ts +0 -2
  23. package/lib/provider/index.d.ts +0 -3
  24. package/lib/provider/navigation/index.d.ts +0 -3
  25. package/lib/provider/navigation/provide.before.unload.guard.d.ts +0 -12
  26. package/lib/provider/navigation/provide.navigation-protection.d.ts +0 -2
  27. package/lib/provider/navigation/provide.popstate-dialog.guard.d.ts +0 -14
  28. package/lib/provider/provide.client.core.d.ts +0 -5
  29. package/lib/service/audit/audit.interface.d.ts +0 -47
  30. package/lib/service/audit/audit.service.d.ts +0 -37
  31. package/lib/service/auth/auth.interceptor.d.ts +0 -6
  32. package/lib/service/auth/auth.interface.d.ts +0 -34
  33. package/lib/service/auth/auth.service.d.ts +0 -54
  34. package/lib/service/backend/api.enum.d.ts +0 -7
  35. package/lib/service/backend/backend.interface.d.ts +0 -21
  36. package/lib/service/backend/backend.service.d.ts +0 -145
  37. package/lib/service/bpm/bpm.interface.d.ts +0 -87
  38. package/lib/service/bpm/bpm.service.d.ts +0 -19
  39. package/lib/service/cache/app-cache.service.d.ts +0 -43
  40. package/lib/service/catalog/catalog.interface.d.ts +0 -12
  41. package/lib/service/catalog/catalog.service.d.ts +0 -5
  42. package/lib/service/client-cache/client-cache.interface.d.ts +0 -5
  43. package/lib/service/client-cache/client-cache.service.d.ts +0 -35
  44. package/lib/service/clipboard/clipboard.interface.d.ts +0 -11
  45. package/lib/service/clipboard/clipboard.service.d.ts +0 -24
  46. package/lib/service/config/config.interface.d.ts +0 -34
  47. package/lib/service/config/config.service.d.ts +0 -37
  48. package/lib/service/config/core-config.d.ts +0 -12
  49. package/lib/service/config/core-config.tokens.d.ts +0 -7
  50. package/lib/service/connection/connection.service.d.ts +0 -31
  51. package/lib/service/connection/offline.interceptor.d.ts +0 -6
  52. package/lib/service/core-init/core-init.service.d.ts +0 -5
  53. package/lib/service/core-init/missing-translation-handler.d.ts +0 -8
  54. package/lib/service/core-init/translate-json-loader.d.ts +0 -20
  55. package/lib/service/device/device.interface.d.ts +0 -15
  56. package/lib/service/device/device.service.d.ts +0 -62
  57. package/lib/service/dms/dms.service.d.ts +0 -207
  58. package/lib/service/dms/dms.service.interface.d.ts +0 -60
  59. package/lib/service/event/custom.events.token.d.ts +0 -3
  60. package/lib/service/event/event.interface.d.ts +0 -36
  61. package/lib/service/event/event.service.d.ts +0 -30
  62. package/lib/service/event/events.d.ts +0 -22
  63. package/lib/service/idm/idm.service.d.ts +0 -43
  64. package/lib/service/idm/models/idm-cached-user.model.d.ts +0 -11
  65. package/lib/service/idm/models/idm-user-cache.model.d.ts +0 -9
  66. package/lib/service/idm/models/idm-user-response.model.d.ts +0 -24
  67. package/lib/service/idm/models/index.d.ts +0 -4
  68. package/lib/service/idm/models/organization-set-entry.model.d.ts +0 -12
  69. package/lib/service/logger/logger.interface.d.ts +0 -10
  70. package/lib/service/logger/logger.service.d.ts +0 -20
  71. package/lib/service/notification/notification.service.d.ts +0 -71
  72. package/lib/service/object-config/object-config.interface.d.ts +0 -62
  73. package/lib/service/object-config/object-config.service.d.ts +0 -40
  74. package/lib/service/object-form/object-form.interface.d.ts +0 -46
  75. package/lib/service/object-form/object-form.model.d.ts +0 -45
  76. package/lib/service/pending-changes/index.d.ts +0 -4
  77. package/lib/service/pending-changes/pending-changes-component.interface.d.ts +0 -6
  78. package/lib/service/pending-changes/pending-changes-dialog.guard.service.d.ts +0 -128
  79. package/lib/service/pending-changes/pending-changes-guard.service.d.ts +0 -14
  80. package/lib/service/pending-changes/pending-changes-tab.guard.directive.d.ts +0 -9
  81. package/lib/service/pending-changes/pending-changes.service.d.ts +0 -58
  82. package/lib/service/prediction/prediction.interface.d.ts +0 -18
  83. package/lib/service/prediction/prediction.service.d.ts +0 -15
  84. package/lib/service/retention/retention.interface.d.ts +0 -5
  85. package/lib/service/retention/retention.service.d.ts +0 -26
  86. package/lib/service/search/search.service.d.ts +0 -55
  87. package/lib/service/search/search.service.interface.d.ts +0 -123
  88. package/lib/service/search/search.utils.d.ts +0 -18
  89. package/lib/service/session-storage/session-storage.service.d.ts +0 -15
  90. package/lib/service/system/system.enum.d.ts +0 -143
  91. package/lib/service/system/system.interface.d.ts +0 -165
  92. package/lib/service/system/system.service.d.ts +0 -175
  93. package/lib/service/toast/toast.interface.d.ts +0 -8
  94. package/lib/service/toast/toast.service.d.ts +0 -17
  95. package/lib/service/toast/toast.styles.d.ts +0 -1
  96. package/lib/service/upload/upload.interface.d.ts +0 -56
  97. package/lib/service/upload/upload.service.d.ts +0 -160
  98. package/lib/service/user/user-storage.service.d.ts +0 -18
  99. package/lib/service/user/user.providers.d.ts +0 -4
  100. package/lib/service/user/user.service.d.ts +0 -67
  101. package/lib/util/utils.d.ts +0 -123
  102. package/lib/util/utils.helper.enum.d.ts +0 -13
@@ -1,40 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { VirtualObjectType } from '../system/system.interface';
3
- import { ObjectConfig, ObjectConfigRecord, ResolvedObjectConfig } from './object-config.interface';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Service managing the configuarions for object types.
7
- * Configuration means that you can pick certain fields
8
- * of an object type and assign them to a config object.
9
- */
10
- export declare class ObjectConfigService {
11
- #private;
12
- OBJECT_CONFIG_STORAGE_KEY: string;
13
- init(): Observable<any>;
14
- getObjectConfigs$(bucket?: string, includeDefaults?: boolean): Observable<ObjectConfigRecord>;
15
- /**
16
- * Register default object configs. Apps can pre-define how their
17
- * objects should be rendered.
18
- * @param bucket Name of a bucket to bind configs to (usually the ID of the app) to
19
- * separate the configs from other apps. If not provided configs will be saved for
20
- * the global scope
21
- */
22
- registerDefaults(configs: ObjectConfigRecord, bucket?: string): void;
23
- unregisterDefaults(configs: ObjectConfigRecord, bucket?: string): void;
24
- getRegisteredDefault(objectTypeId: string, bucket?: string): ObjectConfig | undefined;
25
- /**
26
- * Get object config for an object type.
27
- * @param objectTypeId ID of the object type to get the config for
28
- * @param bucket Optional bucket ID to fetch the config from. Buckets
29
- * define separated areas to store/receive those configs. This way
30
- * components/apps can store different object configs than the ones
31
- * used accross the whole client application.
32
- */
33
- getObjectConfig(type: VirtualObjectType, bucket?: string): ObjectConfig;
34
- saveObjectConfig(type: VirtualObjectType, config?: ObjectConfig, bucket?: string): Observable<any>;
35
- saveObjectConfigs(configs: Record<string, ObjectConfig | undefined>, bucket?: string): Observable<any>;
36
- getDefaultConfig(objectTypeID: string): ObjectConfig;
37
- getResolvedObjectConfig(data: Record<string, any>, type: VirtualObjectType, bucket?: string, includeDefaults?: boolean): ResolvedObjectConfig;
38
- static ɵfac: i0.ɵɵFactoryDeclaration<ObjectConfigService, never>;
39
- static ɵprov: i0.ɵɵInjectableDeclaration<ObjectConfigService>;
40
- }
@@ -1,46 +0,0 @@
1
- import { InternalFieldType } from "../system/system.enum";
2
- import { ObjectTypeField } from "../system/system.interface";
3
- export type ObjectTypeFieldType = 'string' | 'integer' | 'decimal' | 'boolean' | 'table' | 'datetime';
4
- export 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;
5
- export interface FormElementString extends ObjectTypeField {
6
- propertyType: 'string';
7
- defaultvalue?: string[] | string;
8
- maxLength?: number;
9
- minLength?: number;
10
- rows?: number;
11
- options?: string[] | string;
12
- regex?: string;
13
- }
14
- export interface FormElementInteger extends ObjectTypeField {
15
- propertyType: 'integer';
16
- defaultvalue?: number[] | number;
17
- maxValue?: number;
18
- minValue?: number;
19
- precision?: number;
20
- grouping?: boolean;
21
- pattern?: string;
22
- }
23
- export interface FormElementDecimal extends ObjectTypeField {
24
- propertyType: 'decimal';
25
- defaultvalue?: number[] | number;
26
- maxValue?: number;
27
- minValue?: number;
28
- precision?: number;
29
- scale?: number;
30
- grouping?: boolean;
31
- pattern?: string;
32
- }
33
- export interface FormElementBoolean extends ObjectTypeField {
34
- propertyType: 'boolean';
35
- defaultvalue?: boolean;
36
- tristate?: boolean;
37
- }
38
- export interface FormElementDatetime extends ObjectTypeField {
39
- propertyType: 'datetime';
40
- defaultvalue?: string[] | string;
41
- resolution?: 'date';
42
- }
43
- export interface FormElementTable extends ObjectTypeField {
44
- elements: ObjectTypeField[];
45
- propertyType: 'table';
46
- }
@@ -1,45 +0,0 @@
1
- import { FormControl, FormGroup } from '@angular/forms';
2
- export type ObjectFormModel = ObjectFormGroup | ObjectFormControlWrapper;
3
- export declare class ObjectFormControlWrapper extends FormGroup {
4
- _eoFormControlWrapper?: YuvFormGroupWrapper;
5
- }
6
- export interface YuvFormGroupWrapper {
7
- /**
8
- * form control situation (CREATE, EDIT, SEARCH)
9
- */
10
- situation: string;
11
- /**
12
- * the name of the wrapped form control
13
- */
14
- controlName: string;
15
- }
16
- export interface YuvFormGroup {
17
- /**
18
- * the label for the form group
19
- */
20
- label?: string;
21
- /**
22
- * object holding properties defining layout properties of the group
23
- */
24
- layout: any;
25
- /**
26
- * type of group indicating if the form is a stack, a fieldset or a simple group
27
- */
28
- type: string;
29
- }
30
- /**
31
- * @ignore
32
- * Extension of the default angular form group,
33
- */
34
- export declare class ObjectFormGroup extends FormGroup {
35
- _eoFormGroup?: YuvFormGroup;
36
- }
37
- /**
38
- * @ignore
39
- * Extension of the default angular form control,
40
- */
41
- export declare class ObjectFormControl extends FormControl {
42
- private __eoFormElement;
43
- set _eoFormElement(v: any);
44
- get _eoFormElement(): any;
45
- }
@@ -1,4 +0,0 @@
1
- export * from './pending-changes-guard.service';
2
- export * from './pending-changes-dialog.guard.service';
3
- export * from './pending-changes.service';
4
- export * from './pending-changes-tab.guard.directive';
@@ -1,6 +0,0 @@
1
- /**
2
- * Interface to be implemented by all components (state components) that are aware of pending changes
3
- */
4
- export interface PendingChangesComponent {
5
- hasPendingChanges: () => boolean;
6
- }
@@ -1,128 +0,0 @@
1
- import { MatDialogRef } from '@angular/material/dialog';
2
- import { Observable } from 'rxjs';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * Service that provides guards for Material Dialog close operations.
6
- *
7
- * This service allows you to intercept and control dialog close events,
8
- * enabling confirmation dialogs or preventing accidental closure when
9
- * there are unsaved changes or pending operations.
10
- *
11
- * @example
12
- * ```typescript
13
- * readonly #dialogCloseGuard = inject(DialogCloseGuard);
14
- *
15
- * openDialog() {
16
- * const dialogRef = this.dialog.open(MyComponent);
17
- *
18
- * // Prevent dialog from closing if there are unsaved changes
19
- * this.#dialogCloseGuard.dialogCanClose(dialogRef, () => {
20
- * return this.hasUnsavedChanges() ? this.confirmClose() : true;
21
- * }).subscribe();
22
- * }
23
- * ```
24
- */
25
- export declare class DialogCloseGuard {
26
- #private;
27
- /**
28
- * Guards against dialog closure when the backdrop is clicked.
29
- *
30
- * This method disables the default close behavior and only allows the dialog
31
- * to close when the provided check function returns true. The check is triggered
32
- * specifically when the user clicks on the dialog backdrop.
33
- *
34
- * @param dialogRef - Reference to the Material Dialog instance
35
- * @param checkFunction - Function that determines if the dialog can be closed.
36
- * Can return a boolean directly or an Observable<boolean>
37
- * @returns Observable<boolean> - Emits true when the dialog can be closed via backdrop click
38
- *
39
- * @example
40
- * ```typescript
41
- * this.dialogCloseGuard.checkBackdropCanClose(dialogRef, () => {
42
- * return this.formIsDirty ? this.showConfirmDialog() : true;
43
- * }).subscribe(canClose => {
44
- * if (canClose) {
45
- * dialogRef.close();
46
- * }
47
- * });
48
- * ```
49
- */
50
- checkBackdropCanClose(dialogRef: MatDialogRef<any>, checkFunction: () => boolean | Observable<boolean>): Observable<boolean>;
51
- /**
52
- * Guards against dialog closure when the Escape key is pressed.
53
- *
54
- * This method disables the default close behavior and only allows the dialog
55
- * to close when the provided check function returns true. The check is triggered
56
- * specifically when the user presses the Escape key.
57
- *
58
- * @param dialogRef - Reference to the Material Dialog instance
59
- * @param checkFunction - Function that determines if the dialog can be closed.
60
- * Can return a boolean directly or an Observable<boolean>
61
- * @returns Observable<boolean> - Emits true when the dialog can be closed via Escape key
62
- *
63
- * @example
64
- * ```typescript
65
- * this.dialogCloseGuard.checkKeydownEventsCanClose(dialogRef, () => {
66
- * return this.hasUnsavedChanges ? this.confirmDiscardChanges() : true;
67
- * }).subscribe(canClose => {
68
- * if (canClose) {
69
- * dialogRef.close();
70
- * }
71
- * });
72
- * ```
73
- */
74
- checkKeydownEventsCanClose(dialogRef: MatDialogRef<any>, checkFunction: () => boolean | Observable<boolean>): Observable<boolean>;
75
- /**
76
- * Comprehensive dialog close guard that handles both backdrop clicks and Escape key presses.
77
- *
78
- * This method provides a unified approach to guard dialog closure by monitoring both
79
- * backdrop clicks and Escape key events. When either event occurs, it runs the provided
80
- * check function and automatically closes the dialog if the check passes.
81
- *
82
- * This is the most convenient method when you want to guard against all common
83
- * dialog close scenarios with a single setup.
84
- *
85
- * @template T - The type of data that the dialog returns
86
- * @param dialogRef - Reference to the Material Dialog instance
87
- * @param checkFunction - Function that determines if the dialog can be closed.
88
- * Can return a boolean directly or an Observable<boolean>
89
- * @returns Observable<false | void> - Emits false if the dialog cannot be closed,
90
- * or void when the dialog is successfully closed
91
- *
92
- * @example
93
- * ```typescript
94
- * // Simple boolean check
95
- * this.dialogCloseGuard.dialogCanClose(dialogRef, () => !this.hasUnsavedChanges).subscribe();
96
- *
97
- * // Async check with confirmation dialog
98
- * this.dialogCloseGuard.dialogCanClose(dialogRef, () => {
99
- * return this.hasUnsavedChanges
100
- * ? this.confirmationService.confirm('Discard changes?')
101
- * : of(true);
102
- * }).subscribe();
103
- * ```
104
- */
105
- preventCloseUntil<T>(dialogRef: MatDialogRef<T>, checkFunction: () => boolean | Observable<boolean>): Observable<false | void>;
106
- /**
107
- * Specialized dialog close guard that automatically checks for pending changes.
108
- *
109
- * This convenience method provides automatic pending changes detection without
110
- * requiring a custom check function. It integrates with the PendingChangesService
111
- * to determine if there are any unsaved changes, and handles both backdrop clicks
112
- * and Escape key presses automatically.
113
- *
114
- * This method is ideal when you want to prevent dialog closure if there are
115
- * pending changes anywhere in the application, without having to implement
116
- * custom change detection logic.
117
- *
118
- * @template T - The type of data that the dialog returns
119
- * @param dialogRef - Reference to the Material Dialog instance
120
- * @returns Observable<false | void> - Emits false if there are pending changes
121
- * preventing closure, or void when the dialog
122
- * is successfully closed
123
- *
124
- */
125
- pendingChangesDialogCanClose<T>(dialogRef: MatDialogRef<T>): Observable<false | void>;
126
- static ɵfac: i0.ɵɵFactoryDeclaration<DialogCloseGuard, never>;
127
- static ɵprov: i0.ɵɵInjectableDeclaration<DialogCloseGuard>;
128
- }
@@ -1,14 +0,0 @@
1
- import { CanDeactivate } from '@angular/router';
2
- import { PendingChangesComponent } from './pending-changes-component.interface';
3
- import { PendingChangesService } from './pending-changes.service';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Providing a `PendingChangesComponent`.
7
- */
8
- export declare class PendingChangesGuard implements CanDeactivate<PendingChangesComponent> {
9
- private pendingChanges;
10
- constructor(pendingChanges: PendingChangesService);
11
- canDeactivate(component: PendingChangesComponent): boolean;
12
- static ɵfac: i0.ɵɵFactoryDeclaration<PendingChangesGuard, never>;
13
- static ɵprov: i0.ɵɵInjectableDeclaration<PendingChangesGuard>;
14
- }
@@ -1,9 +0,0 @@
1
- import { DoCheck } from '@angular/core';
2
- import * as i0 from "@angular/core";
3
- export declare class TabGuardDirective implements DoCheck {
4
- #private;
5
- constructor();
6
- ngDoCheck(): void;
7
- static ɵfac: i0.ɵɵFactoryDeclaration<TabGuardDirective, never>;
8
- static ɵdir: i0.ɵɵDirectiveDeclaration<TabGuardDirective, "mat-tab-group[yuvTabGuardDisable]", never, {}, {}, never, never, true, never>;
9
- }
@@ -1,58 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { PendingChangesComponent } from './pending-changes-component.interface';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * EditingObserver service is used to track changes made inside the application, that should prevent
6
- * doing something or going somewhere before the changes are persisted or ignored. For example when
7
- * the user starts editing form data and tries to navigate away before saving the changes, this service
8
- * will take care of notifying the user.
9
- *
10
- * It is working kind of like a registry for ongoing tasks that need to be monitored. Every component
11
- * that needs to be aware of changes to be persisted can start a task and finish it when everything is done.
12
- *
13
- * Other components can ask the service for pending tasks to know whether or not to execute an action
14
- * (e.g. list component will subscribe and prevent selecting another list item, if changes to the previous one haven't be finished)
15
- *
16
- * app.component will prevent relevant route changes while tasks are pending.
17
- */
18
- export declare class PendingChangesService {
19
- #private;
20
- tasks$: Observable<{
21
- id: string;
22
- message?: string;
23
- }[]>;
24
- /**
25
- * Registers a task to be pending.
26
- * @param message alert message
27
- * @returns Unique id to be used for finishing this task
28
- */
29
- startTask(message: string): string;
30
- /**
31
- * Finishes a task
32
- * @param id The id of the task to be finished. This is the one the component got from startTask()
33
- */
34
- finishTask(id: string): void;
35
- /**
36
- * Returns whether or not the service has pending tasks.
37
- * If an id is provided, the method will check existence of one specific task.
38
- *
39
- * @param id The id of the task to be checked
40
- * @returns
41
- */
42
- hasPendingTask(id?: string | string[]): boolean;
43
- /**
44
- * Returns whether or not the component|service has pending tasks.
45
- * Checks via confirm dialog
46
- * @param component
47
- * @returns false if there are no pending changes or user confirmed
48
- * to continue, true if there are pending changes and user canceled the action
49
- */
50
- check(component?: PendingChangesComponent): boolean;
51
- checkForPendingTasks(taskIds: string | string[]): boolean;
52
- /**
53
- * Clear list of pending tasks
54
- */
55
- clear(): void;
56
- static ɵfac: i0.ɵɵFactoryDeclaration<PendingChangesService, never>;
57
- static ɵprov: i0.ɵɵInjectableDeclaration<PendingChangesService>;
58
- }
@@ -1,18 +0,0 @@
1
- export interface PredictionClassifyResult {
2
- objectId: string;
3
- properties: PredictionClassifyResultItem[];
4
- }
5
- export interface PredictionClassifyResultItem {
6
- type: string;
7
- probability: number;
8
- }
9
- export interface PredictionExtractResult {
10
- objectId: string;
11
- properties: Record<string, PredictionExtractResultItem[]>;
12
- }
13
- export interface PredictionExtractResultItem {
14
- value: string;
15
- probability: number;
16
- boundingBox?: number[];
17
- page?: number;
18
- }
@@ -1,15 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { PredictionClassifyResult, PredictionExtractResult } from './prediction.interface';
3
- import * as i0 from "@angular/core";
4
- export declare class PredictionService {
5
- #private;
6
- classify(objectIDs: string[], schemaObjectTypeId?: string): Observable<Record<string, PredictionClassifyResult>>;
7
- /**
8
- * @param schemaObjectTypeId
9
- * @param objectIDs
10
- * @returns Observable<Record<string, PredictionClassifyResult>> string is objectID
11
- */
12
- extract(schemaObjectTypeId: string, objectIDs: string[]): Observable<Record<string, PredictionExtractResult>>;
13
- static ɵfac: i0.ɵɵFactoryDeclaration<PredictionService, never>;
14
- static ɵprov: i0.ɵɵInjectableDeclaration<PredictionService>;
15
- }
@@ -1,5 +0,0 @@
1
- export interface RetentionState {
2
- underRetention: boolean;
3
- start?: Date;
4
- end?: Date;
5
- }
@@ -1,26 +0,0 @@
1
- import { DmsObject } from '../../model/dms-object.model';
2
- import { RetentionState } from './retention.interface';
3
- import { Observable } from 'rxjs';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Service to manage retention for DMS objects. This service allows to set retention
7
- * for objects and revert retention if necessary/possible.
8
- */
9
- export declare class RetentionService {
10
- #private;
11
- /**
12
- * Set retention for given objects. This will add the retention SOT to the objects
13
- * and set the retention start and end date. If the retetion start date is in the
14
- * future, you can revert the retention until then by calling `revertRetention`.
15
- * @param dmsObjects The objects to set retention for
16
- * @param retentionStart Date when retention period should begin
17
- * @param retentionEnd Date when retention period should end
18
- * @param destructionDate Date when the object should be destroyed. This right now is just a
19
- * marker and has no effect on the object lifecycle.
20
- * @returns The updated objects
21
- */
22
- setRetention(dmsObjects: DmsObject[], retentionStart: Date, retentionEnd: Date, destructionDate?: Date): Observable<DmsObject[]>;
23
- getRetentionState(dmsObject: DmsObject): RetentionState;
24
- static ɵfac: i0.ɵɵFactoryDeclaration<RetentionService, never>;
25
- static ɵprov: i0.ɵɵInjectableDeclaration<RetentionService>;
26
- }
@@ -1,55 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { AggregateResult, SearchFilter, SearchQuery, SearchResponse, SearchResult } from './search.service.interface';
3
- import { RangeValue } from '../../model/range-value.interface';
4
- import * as i0 from "@angular/core";
5
- export declare class SearchService {
6
- #private;
7
- static DEFAULT_QUERY_SIZE: number;
8
- /**
9
- * Execute a search query ans transform the result to a SearchResult object
10
- * @param query The search query
11
- * @returns Observable of a SearchResult
12
- */
13
- search(query: SearchQuery): Observable<SearchResult>;
14
- /**
15
- * Execute a raw search query and return the result as is.
16
- * @param query The search query
17
- * @returns Observable of the raw search result
18
- */
19
- searchRaw(query: SearchQuery): Observable<any>;
20
- /**
21
- * Search for objects in the dms using CMIS like SQL syntax.
22
- * @param statement The query statement
23
- * @param size The number of items to return
24
- * @returns Observable of a SearchResult
25
- */
26
- searchCmis(statement: string, size?: number, includePermissions?: boolean): Observable<SearchResult>;
27
- /**
28
- * Fetch aggragations for a given query.
29
- * @param q The query
30
- * @param aggregations List of aggregations to be fetched (e.g. `enaio:objectTypeId`
31
- * to get an aggregation of object types)
32
- */
33
- aggregate(q: SearchQuery, aggregations: string[]): Observable<AggregateResult>;
34
- /**
35
- * Go to a page of a search result.
36
- * @param query SearchQuery or CMIS query statement
37
- * @param page The number of the page to go to
38
- */
39
- getPage(query: SearchQuery | string, page: number, pageSize?: number, includePermissions?: boolean): Observable<SearchResult>;
40
- /**
41
- * Map search result from the backend to applications SearchResult object
42
- * @param searchResponse The backend response
43
- */
44
- toSearchResult(searchResponse: SearchResponse, pageSize?: number, skipCount?: number): SearchResult;
45
- /**
46
- * Maps data extracted from a search form to search filters. Every key of the form data object
47
- * will be mapped to a search filter.
48
- * @param formData form data
49
- * @returns Array of search filters
50
- */
51
- formDataToSearchFilter(formData: Record<string, unknown>): SearchFilter[];
52
- rangeValueToSearchFilter(value: RangeValue, property: string): SearchFilter | undefined;
53
- static ɵfac: i0.ɵɵFactoryDeclaration<SearchService, never>;
54
- static ɵprov: i0.ɵɵInjectableDeclaration<SearchService>;
55
- }
@@ -1,123 +0,0 @@
1
- import { ContentStream, CoreApiObject } from '../dms/dms.service.interface';
2
- export type DateRange = 'today' | 'yesterday' | 'thisWeek' | 'lastWeek' | 'thisMonth' | 'lastMonth' | 'thisYear' | 'lastYear';
3
- export type FilesizeRange = 'small' | 'medium' | 'large' | 'verylarge';
4
- export interface SearchQuery {
5
- term?: string;
6
- scope?: 'metadata' | 'content';
7
- size?: number;
8
- from?: number;
9
- fields?: string[];
10
- aggs?: string[];
11
- types?: string[];
12
- filters?: SearchFilter[];
13
- tableFilters?: TableFilter[];
14
- sort?: SortOption[];
15
- includePermissions?: boolean;
16
- }
17
- export interface SortOption {
18
- field: string;
19
- order: 'asc' | 'desc';
20
- }
21
- export interface SearchFilter {
22
- f: string;
23
- o: Operator;
24
- v1: unknown;
25
- v2?: unknown;
26
- useNot?: boolean;
27
- }
28
- export interface TableFilter {
29
- table: string;
30
- columnFilters: SearchFilter[];
31
- }
32
- export declare enum Operator {
33
- EQUAL = "eq",// equal
34
- EEQUAL = "eeq",// exact equal
35
- IN = "in",// match at least one of the provided values (value has to be an array)
36
- GREATER_THAN = "gt",// greater than
37
- GREATER_OR_EQUAL = "gte",// greater than or equal
38
- LESS_THAN = "lt",// less than
39
- LESS_OR_EQUAL = "lte",// less than or equal
40
- INTERVAL = "gtlt",// interval
41
- INTERVAL_INCLUDE_BOTH = "gtelte",// interval include left and right
42
- INTERVAL_INCLUDE_TO = "gtlte",// interval include right
43
- INTERVAL_INCLUDE_FROM = "gtelt",// interval include left
44
- RANGE = "rg",// aggegation ranges
45
- LIKE = "like",// like
46
- CONTAINS = "contains"
47
- }
48
- export declare const OperatorLabel: {
49
- /** equal */
50
- EQUAL: string;
51
- /** exact equal */
52
- EEQUAL: string;
53
- /** match at least one of the provided values (value has to be an array) */
54
- IN: string;
55
- /** greater than */
56
- GREATER_THAN: string;
57
- /** greater than or equal */
58
- GREATER_OR_EQUAL: string;
59
- LESS_THAN: string;
60
- LESS_OR_EQUAL: string;
61
- INTERVAL: string;
62
- INTERVAL_INCLUDE_BOTH: string;
63
- INTERVAL_INCLUDE_TO: string;
64
- INTERVAL_INCLUDE_FROM: string;
65
- RANGE: string;
66
- LIKE: string;
67
- CONTAINS: string;
68
- };
69
- export interface SearchResponse {
70
- hasMoreItems: boolean;
71
- numItems: number;
72
- totalNumItems: number;
73
- objects: CoreApiObject[];
74
- }
75
- /**
76
- * Interface providing a search service
77
- */
78
- export interface SearchResult {
79
- hasMoreItems: boolean;
80
- totalNumItems: number;
81
- items: SearchResultItem[];
82
- objectTypes: string[];
83
- paging?: {
84
- page: number;
85
- totalPages: number;
86
- };
87
- }
88
- /**
89
- * Interface for the item of search results
90
- */
91
- export interface SearchResultItem {
92
- objectTypeId: string;
93
- content?: SearchResultContent;
94
- permissions?: SearchResultPermissions;
95
- fields: Map<string, any>;
96
- }
97
- export interface SearchResultPermissions {
98
- read: Array<'metadata' | 'content'>;
99
- write: Array<'metadata' | 'content'>;
100
- delete: Array<'object' | 'content'>;
101
- }
102
- export type SearchResultContent = ContentStream;
103
- /**
104
- * Interface providing the estimated result of the current query.
105
- */
106
- export interface AggregateResult {
107
- /**
108
- * number of results found
109
- */
110
- totalNumItems: number;
111
- aggregations: Aggregation[];
112
- }
113
- export interface AggregationEntry {
114
- key: string;
115
- count: number;
116
- }
117
- /**
118
- * Property of a one search query aggregation
119
- */
120
- export interface Aggregation {
121
- aggKey: string;
122
- entries: AggregationEntry[];
123
- }
@@ -1,18 +0,0 @@
1
- import { RangeValue } from '../../model/range-value.interface';
2
- import { DateRange, FilesizeRange } from './search.service.interface';
3
- export declare class SearchUtils {
4
- static dateRanges: string[];
5
- static filesizeRanges: string[];
6
- static dateRangeStartEnd(dateRange: DateRange): {
7
- start: Date;
8
- end: Date;
9
- };
10
- /**
11
- * Maps a date range filter to a date range value like 'thisWeek', 'lastMonth', etc.
12
- * @param rangeValue the range value
13
- * @returns the date range (eg. 'thisWeek', 'lastMonth', etc.)
14
- */
15
- static getMatchingDateRange(rangeValue: RangeValue): DateRange | undefined;
16
- static getMatchingFilesizeRange(rangeValue: RangeValue): FilesizeRange | undefined;
17
- static filesizeRangeToRangeValue(filesizeRange: FilesizeRange): RangeValue | undefined;
18
- }
@@ -1,15 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- export declare class SessionStorageService {
3
- #private;
4
- constructor();
5
- /**
6
- * Add a reference to a temporary localstorage entry that should be cleared when a
7
- * new browser session starts. In context of forms this will be used to cleanup the
8
- * layout state of forms (selected tabs etc.) that are stored locally but should only
9
- * be pesisted for one browser session.
10
- * @param storageKey Key of the localstorage item
11
- */
12
- addTemporaryStorageEntry(storageKey: string): void;
13
- static ɵfac: i0.ɵɵFactoryDeclaration<SessionStorageService, never>;
14
- static ɵprov: i0.ɵɵInjectableDeclaration<SessionStorageService>;
15
- }