@yuuvis/client-core 3.5.0 → 3.7.0

package/fesm2022/yuuvis-client-core.mjs

@@ -299,30 +299,6 @@ class DmsObject {
         }
         this.sots = searchResultItem.fields.get(BaseObjectTypeField.SECONDARY_OBJECT_TYPE_IDS) || [];
     }
-    // /**
-    //  * Get the value (state) of a certain tag
-    //  * @param name The tags name
-    //  * @returns The value of the tag or null if the tag does not exist
-    //  */
-    // getTag(name: string): any {
-    //   const tags: unknown[][] = this.data[BaseObjectTypeField.TAGS] as unknown[][];
-    //   const tag: unknown[] | null = tags ? (tags.find((t: any) => t[0] === name) as unknown[]) : null;
-    //   return tag ? tag[1] : null;
-    // }
-    // getRetentionState(): RetentionState {
-    //   if (this.data[RetentionField.RETENTION_START]) {
-    //     const retentionStart = new Date(this.data[RetentionField.RETENTION_START] as string);
-    //     const retentionEnd = new Date(this.data[RetentionField.RETENTION_END] as string);
-    //     const today = new Date();
-    //     return retentionStart <= today && today <= retentionEnd
-    //       ? RetentionState.ACTIVE
-    //       : today < retentionStart
-    //         ? RetentionState.INACTIVE
-    //         : RetentionState.DESTRUCT;
-    //   } else {
-    //     return RetentionState.NONE;
-    //   }
-    // }
     #generateData(fields) {
         const result = {};
         for (const [key, val] of fields.entries()) {
@@ -3343,6 +3319,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.12", ngImpo
 
 const LOCALIZATION_COLUMNS = ['locale', 'label', 'description'];
 
+// Accepts both the `CreatedObject` shape (non-silent path, body?: ...) and a raw
+// `HttpResponse` (silent path, body: ... | null), so both upload branches emit the same array.
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 const transformResponse = () => map((res) => (res.body ? res.body.objects.map((val) => val) : null));
 /**
@@ -3586,7 +3564,7 @@ class UploadService {
         const label = options.label || file.name;
         const request = this.#createHttpRequest(url, { file }, !silent);
         return silent
-            ? this.#http.request(request).pipe(filter((res) => res instanceof HttpResponse))
+            ? this.#http.request(request).pipe(filter((res) => res instanceof HttpResponse), transformResponse())
             : this.#startUploadWithFile(request, label, options.scope).pipe(transformResponse());
     }
     /**
@@ -3602,7 +3580,7 @@ class UploadService {
         const formData = this.#createFormData({ file: files, data });
         const request = this.#createHttpRequest(url, { formData }, !silent);
         return silent
-            ? this.#http.request(request).pipe(filter((res) => res instanceof HttpResponse))
+            ? this.#http.request(request).pipe(filter((res) => res instanceof HttpResponse), transformResponse())
             : this.#startUploadWithFile(request, label, options.scope).pipe(transformResponse());
     }
     #generateResult(result) {
@@ -4075,12 +4053,22 @@ class DmsService {
             .get(`/dms/objects/${id}/versions/${version}`)
             .pipe(map((res) => this.#searchResultToDmsObject(this.#searchService.toSearchResult(res).items[0])));
     }
+    /**
+     * Transforms a Core-API response holding one or more objects (`{ objects: [...] }`) into DmsObjects.
+     * Unwraps each property `value`, folds in the content stream and tags, just like a regular fetch.
+     * @param response The Core-API response (e.g. fetch, batch or lock/unlock response)
+     * @returns Array of DmsObjects (empty array if the response has no objects)
+     */
+    coreResponseToDmsObjects(response) {
+        return this.toSearchResult(response).items.map((item) => this.#searchResultToDmsObject(item));
+    }
+    /**
+     * Transforms a single Core-API object response into a DmsObject.
+     * @param res The Core-API object response (`{ properties, contentStreams }`)
+     * @returns The mapped DmsObject
+     */
     coreApiResponseToDmsObject(res) {
-        return this.#searchResultToDmsObject({
-            objectTypeId: res.properties[BaseObjectTypeField.OBJECT_TYPE_ID].value,
-            fields: new Map(Object.entries(res.properties)),
-            content: res.contentStreams?.[0]
-        });
+        return this.coreResponseToDmsObjects({ objects: [res] })[0];
     }
     /**
      * Transforms a plain data object to a DmsObject.
@@ -5517,7 +5505,7 @@ const DEFAULT_LOCK_OPTIONS = {
     lockTag: LockField.LOCK_TAG,
     state: 1,
     override: false,
-    includeObjects: true
+    includeObjects: false
 };
 
 /**
@@ -5526,24 +5514,26 @@ const DEFAULT_LOCK_OPTIONS = {
 class ObjectLockingService {
     #backend = inject(BackendService);
     #userService = inject(UserService);
-    /**
-     * Lock a DMS object by setting a lock tag with a given state.
-     * @param id ID of the object to lock
-     * @returns Observable emitting the updated tag data of the locked object
-     * @see {@link ObjectLockingResponse}
-     */
-    lock(id) {
-        const { lockTag, state, override, includeObjects } = DEFAULT_LOCK_OPTIONS;
-        return this.#backend.post(`/dms/objects/${id}/tags/${lockTag}/state/${state}?overwrite=${override}&includeObjects=${includeObjects}`, undefined, ApiBase.core);
-    }
-    /**
-     * Remove the lock tag from a DMS object.
-     * @param id ID of the object to unlock
-     * @param lockTag Tag identifier to remove; defaults to `LockField.LOCK_TAG`
-     * @returns Observable that completes once the tag has been deleted
-     */
-    unlock(id, lockTag = LockField.LOCK_TAG) {
-        return this.#backend.delete(`/dms/objects/${id}/tags/${lockTag}`, ApiBase.core);
+    #dms = inject(DmsService);
+    lock(id, includeObjects = DEFAULT_LOCK_OPTIONS.includeObjects) {
+        const { lockTag, state, override } = DEFAULT_LOCK_OPTIONS;
+        const params = this.#searchQueryParams([
+            { name: 'overwrite', value: `${override}` },
+            { name: 'waitForSearchConsistency', value: 'true' },
+            { name: 'includeObjects', value: `${includeObjects}` }
+        ]);
+        const requestUrl = `/dms/objects/${id}/tags/${lockTag}/state/${state}?${params}`;
+        const req$ = this.#backend.post(requestUrl, undefined, ApiBase.core);
+        return includeObjects ? req$.pipe(map((res) => this.#dms.coreApiResponseToDmsObject(res.objects[0]))) : req$;
+    }
+    unlock(id, lockTag = LockField.LOCK_TAG, includeObjects = DEFAULT_LOCK_OPTIONS.includeObjects) {
+        const params = this.#searchQueryParams([
+            { name: 'waitForSearchConsistency', value: 'true' },
+            { name: 'includeObjects', value: `${includeObjects}` }
+        ]);
+        const requestUrl = `/dms/objects/${id}/tags/${lockTag}?${params}`;
+        const req$ = this.#backend.delete(requestUrl, ApiBase.core);
+        return includeObjects ? req$.pipe(map((res) => this.#dms.coreApiResponseToDmsObject(res.objects[0]))) : req$;
     }
     /**
      * Inspect the lock state of a DMS object relative to the current user.
@@ -5562,6 +5552,11 @@ class ObjectLockingService {
             ownerId
         };
     }
+    #searchQueryParams(options) {
+        const params = new URLSearchParams();
+        options.forEach(({ name, value }) => value !== undefined && params.set(name, value));
+        return params.toString();
+    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.12", ngImport: i0, type: ObjectLockingService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.12", ngImport: i0, type: ObjectLockingService, providedIn: 'root' }); }
 }