@yuuvis/client-core 3.6.0 → 3.7.0

package/package.json

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

package/types/yuuvis-client-core.d.ts

@@ -1647,7 +1647,21 @@ declare class DmsService {
      */
     getDmsObjectVersions(id: string): Observable<DmsObject[]>;
     getDmsObjectVersion(id: string, version: number): Observable<DmsObject>;
-    coreApiResponseToDmsObject(res: CoreApiResponse): DmsObject;
+    /**
+     * 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: {
+        objects: CoreApiObject[];
+    }): DmsObject[];
+    /**
+     * 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: CoreApiObject): DmsObject;
     /**
      * Transforms a plain data object to a DmsObject.
      * @param data The plain data object
@@ -2542,18 +2556,11 @@ interface LockOptions {
 }
 declare const DEFAULT_LOCK_OPTIONS: LockOptions;
 /**
- * Response payload returned by the lock endpoint. Contains the updated tag rows
- * of the affected object under `LockField.LOCK_TAG`.
+ * Response payload returned by the lock/unlock endpoints. Contains the affected
+ * object(s) as core-API responses, including the updated `LockField.LOCK_TAG` tag rows.
  */
 interface ObjectLockingResponse {
-    objects: {
-        properties: {
-            'system:tags': {
-                value: (number | string)[][];
-                columnNames: string[];
-            };
-        };
-    }[];
+    objects: CoreApiResponse[];
 }
 
 /**
@@ -2573,19 +2580,31 @@ interface LockState {
 declare class ObjectLockingService {
     #private;
     /**
-     * Lock a DMS object by setting a lock tag with a given state.
+     * Lock a DMS object by setting a lock tag and resolve to the raw lock response.
      * @param id ID of the object to lock
-     * @returns Observable emitting the updated tag data of the locked object
-     * @see {@link ObjectLockingResponse}
+     * @returns Observable emitting the raw {@link ObjectLockingResponse}
+     */
+    lock(id: string, includeObjects?: false): Observable<ObjectLockingResponse>;
+    /**
+     * Lock a DMS object and resolve to the updated {@link DmsObject}.
+     * @param id ID of the object to lock
+     * @param includeObjects Pass `true` to receive the mapped `DmsObject` instead of the raw response
+     */
+    lock(id: string, includeObjects: true): Observable<DmsObject>;
+    /**
+     * Remove the lock tag from a DMS object and resolve to the raw lock response.
+     * @param id ID of the object to unlock
+     * @param lockTag Tag identifier to remove; defaults to `LockField.LOCK_TAG`
+     * @returns Observable emitting the raw {@link ObjectLockingResponse}
      */
-    lock(id: string): Observable<ObjectLockingResponse>;
+    unlock(id: string, lockTag?: string, includeObjects?: false): Observable<ObjectLockingResponse>;
     /**
-     * Remove the lock tag from a DMS object.
+     * Remove the lock tag from a DMS object and resolve to the updated {@link DmsObject}.
      * @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
+     * @param includeObjects Pass `true` to receive the mapped `DmsObject` instead of the raw response
      */
-    unlock(id: string, lockTag?: string): Observable<void>;
+    unlock(id: string, lockTag: string | undefined, includeObjects: true): Observable<DmsObject>;
     /**
      * Inspect the lock state of a DMS object relative to the current user.
      * @param dmsObject Object to inspect