@yuuvis/client-core 0.7.4 → 0.9.0

package/index.d.ts

@@ -44,7 +44,10 @@ export * from './lib/service/pending-changes/pending-changes-guard.service';
 export * from './lib/service/pending-changes/pending-changes.service';
 export * from './lib/service/prediction/prediction.interface';
 export * from './lib/service/prediction/prediction.service';
+export * from './lib/service/retention/retention.service';
+export * from './lib/service/retention/retention.interface';
 export * from './lib/service/search/search.service';
+export * from './lib/service/search/search.utils';
 export * from './lib/service/search/search.service.interface';
 export * from './lib/service/session-storage/session-storage.service';
 export * from './lib/service/system/object-form.interface';
@@ -54,6 +57,7 @@ export * from './lib/service/system/system.service';
 export * from './lib/service/upload/upload.interface';
 export * from './lib/service/upload/upload.service';
 export * from './lib/service/user/user.service';
+export * from './lib/service/user/user-storage.service';
 export * from './lib/util/utils';
 export * from './lib/util/utils.helper.enum';
 export * from './lib/client-core.module';

package/lib/service/clipboard/clipboard.service.d.ts

@@ -18,6 +18,7 @@ export declare class ClipboardService {
      */
     addObjects(objects: DmsObject[], mode: ClipboardDataMode, bucket?: string): void;
     clear(bucket?: string): void;
+    addToNavigatorClipBoard(data: string): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ClipboardService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ClipboardService>;
 }

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

@@ -0,0 +1,5 @@
+export interface RetentionState {
+    underRetention: boolean;
+    start?: Date;
+    end?: Date;
+}

package/lib/service/retention/retention.service.d.ts

@@ -0,0 +1,26 @@
+import { DmsObject } from '../../model/dms-object.model';
+import { RetentionState } from './retention.interface';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Service to manage retention for DMS objects. This service allows to set retention
+ * for objects and revert retention if necessary/possible.
+ */
+export declare class RetentionService {
+    #private;
+    /**
+     * Set retention for given objects. This will add the retention SOT to the objects
+     * and set the retention start and end date. If the retetion start date is in the
+     * future, you can revert the retention until then by calling `revertRetention`.
+     * @param dmsObjects The objects to set retention for
+     * @param retentionStart Date when retention period should begin
+     * @param retentionEnd Date when retention period should end
+     * @param destructionDate Date when the object should be destroyed. This right now is just a
+     * marker and has no effect on the object lifecycle.
+     * @returns The updated objects
+     */
+    setRetention(dmsObjects: DmsObject[], retentionStart: Date, retentionEnd: Date, destructionDate?: Date): Observable<DmsObject[]>;
+    getRetentionState(dmsObject: DmsObject): RetentionState;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RetentionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RetentionService>;
+}

package/lib/service/search/search.service.d.ts

@@ -1,5 +1,6 @@
 import { Observable } from 'rxjs';
-import { AggregateResult, SearchQuery, SearchResponse, SearchResult } from './search.service.interface';
+import { AggregateResult, SearchFilter, SearchQuery, SearchResponse, SearchResult } from './search.service.interface';
+import { RangeValue } from '../../model/range-value.interface';
 import * as i0 from "@angular/core";
 export declare class SearchService {
     #private;
@@ -41,6 +42,14 @@ export declare class SearchService {
      * @param searchResponse The backend response
      */
     toSearchResult(searchResponse: SearchResponse): SearchResult;
+    /**
+     * Maps data extracted from a search form to search filters. Every key of the form data object
+     * will be mapped to a search filter.
+     * @param formData form data
+     * @returns Array of search filters
+     */
+    formDataToSearchFilter(formData: Record<string, unknown>): SearchFilter[];
+    rangeValueToSearchFilter(value: RangeValue, property: string): SearchFilter | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<SearchService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SearchService>;
 }

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

@@ -1,7 +1,9 @@
 import { ContentStream, CoreApiObject } from '../dms/dms.service.interface';
+export type DateRange = 'today' | 'yesterday' | 'thisWeek' | 'lastWeek' | 'thisMonth' | 'lastMonth' | 'thisYear' | 'lastYear';
+export type FilesizeRange = 'small' | 'medium' | 'large' | 'verylarge';
 export interface SearchQuery {
     term?: string;
-    scope?: 'all' | 'metadata' | 'content';
+    scope?: 'metadata' | 'content';
     size?: number;
     from?: number;
     fields?: string[];

package/lib/service/search/search.utils.d.ts

@@ -0,0 +1,18 @@
+import { RangeValue } from '../../model/range-value.interface';
+import { DateRange, FilesizeRange } from './search.service.interface';
+export declare class SearchUtils {
+    static dateRanges: string[];
+    static filesizeRanges: string[];
+    static dateRangeStartEnd(dateRange: DateRange): {
+        start: Date;
+        end: Date;
+    };
+    /**
+     * Maps a date range filter to a date range value like 'thisWeek', 'lastMonth', etc.
+     * @param rangeValue the range value
+     * @returns the date range (eg. 'thisWeek', 'lastMonth', etc.)
+     */
+    static getMatchingDateRange(rangeValue: RangeValue): DateRange | undefined;
+    static getMatchingFilesizeRange(rangeValue: RangeValue): FilesizeRange | undefined;
+    static filesizeRangeToRangeValue(filesizeRange: FilesizeRange): RangeValue | undefined;
+}

package/lib/service/system/system.enum.d.ts

@@ -30,12 +30,6 @@ export declare const RetentionField: {
     RETENTION_START: string;
     DESTRUCTION_DATE: string;
 };
-export declare enum RetentionState {
-    NONE = 0,
-    ACTIVE = 1,
-    DESTRUCT = 2,
-    INACTIVE = 3
-}
 export declare const BaseObjectTypeField: {
     PARENT_ID: string;
     PARENT_OBJECT_TYPE_ID: string;

package/lib/service/user/user-storage.service.d.ts

@@ -0,0 +1,18 @@
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Service providing user related remote storage. This service is used load and
+ * store user related data from any device.
+ */
+export declare class UserStorageService {
+    #private;
+    /**
+     *
+     * @param section section key for
+     * @param value  value to be stored
+     */
+    getItem(section: string): Observable<Record<string, any> | undefined>;
+    setItem(section: string, data: Record<string, any>): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<UserStorageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<UserStorageService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuuvis/client-core",
-  "version": "0.7.4",
+  "version": "0.9.0",
   "author": "OPTIMAL SYSTEMS GmbH <npm@optimal-systems.de>",
   "license": "MIT",
   "peerDependencies": {