visualvault-api 2.0.0-beta.0 → 2.0.0-beta.2

package/dist/config.yml

@@ -21,6 +21,8 @@ ResourceUri:
   DocumentsIdOcr: /documents/{id}/ocr
   DocumentsIdRelateDocument: /documents/{id}/relateDocument
   DocumentsIdExpiration: /documents/{id}/expiration
+  DocumentsWebDavUrl: /documents/{id}/webdavurl
+  DocumentsWopiUrl: /documents/{id}/wopiurl
   Files: /files
   FilesQuery: /files?q=
   FilesId: /files/{id}
@@ -95,6 +97,7 @@ ResourceUri:
     ObjectById: /object/{id}
     ObjectSearchByModelId: /object/search/{modelId}
   StudioApi:
+    ResourceUserFeatures: /resources/userFeatures
     WorkflowLatestPublished: /workflows/latest/published
     WorkflowLatestPublishedId: /workflows/latest/published/{id}
     WorkflowVariables: /workflows/{id}/variables

package/dist/index.cjs

@@ -608,9 +608,9 @@ var common_default = {
   authorize: Authorize
 };
 
-// lib/docApi/documentInstanceManager.js
+// lib/docApi/documentManager.js
 init_cjs_shims();
-var DocumentInstanceManager = class {
+var DocumentManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -671,7 +671,7 @@ var DocApi = class {
     this.baseUrl = docApiConfig["apiUrl"] || null;
     this.roleSecurity = docApiConfig["roleSecurity"] || false;
     if (this.isEnabled) {
-      this.documentInstances = new DocumentInstanceManager(this._httpHelper);
+      this.documents = new DocumentManager(this._httpHelper);
     }
   }
 };
@@ -730,9 +730,9 @@ var FormsApi_default = FormsApi;
 // lib/ObjectsApi.js
 init_cjs_shims();
 
-// lib/objectsApi/modelsManager.js
+// lib/objectsApi/modelManager.js
 init_cjs_shims();
-var ModelsManager = class {
+var ModelManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -761,11 +761,11 @@ var ModelsManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
 };
-var modelsManager_default = ModelsManager;
+var modelManager_default = ModelManager;
 
-// lib/objectsApi/objectsManager.js
+// lib/objectsApi/objectManager.js
 init_cjs_shims();
-var ObjectsManager = class {
+var ObjectManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -843,7 +843,7 @@ var ObjectsManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
 };
-var objectsManager_default = ObjectsManager;
+var objectManager_default = ObjectManager;
 
 // lib/ObjectsApi.js
 var import_js_yaml4 = __toESM(require("js-yaml"), 1);
@@ -862,8 +862,8 @@ var ObjectsApi = class {
     this.isEnabled = objectsApiConfig["isEnabled"] || false;
     this.baseUrl = objectsApiConfig["apiUrl"] || null;
     if (this.isEnabled) {
-      this.models = new modelsManager_default(this._httpHelper);
-      this.objects = new objectsManager_default(this._httpHelper);
+      this.models = new modelManager_default(this._httpHelper);
+      this.objects = new objectManager_default(this._httpHelper);
     }
   }
 };
@@ -972,6 +972,27 @@ var WorkflowManager = class {
 };
 var workflowManager_default = WorkflowManager;
 
+// lib/studioApi/rolesAndPermissionsManager.js
+init_cjs_shims();
+var RolesAndPermissionsManager = class {
+  constructor(httpHelper) {
+    this._httpHelper = httpHelper;
+  }
+  /**
+   * Retrieves available features for the requesting user
+   * @param {object} params - Optional URL parameters to include in the request
+   */
+  async getUserFeatures(params) {
+    var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.ResourceUserFeatures;
+    var url = this._httpHelper.getUrl(resourceUri);
+    var opts = { method: "GET" };
+    var data = {};
+    params = params || {};
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+};
+var rolesAndPermissionsManager_default = RolesAndPermissionsManager;
+
 // lib/StudioApi.js
 var import_js_yaml5 = __toESM(require("js-yaml"), 1);
 var import_fs5 = __toESM(require("fs"), 1);
@@ -990,6 +1011,7 @@ var StudioApi = class {
     this.baseUrl = studioApiConfig["studioApiUrl"] || null;
     if (this.isEnabled) {
       this.workflow = new workflowManager_default(this._httpHelper);
+      this.permissions = new rolesAndPermissionsManager_default(this._httpHelper);
     }
   }
 };
@@ -1777,9 +1799,8 @@ var UsersManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
   getCurrentUser() {
-    const resourceUri = this._httpHelper._config.ResourceUri.UsersWhoAmI;
-    const baseUrl = this._httpHelper._sessionToken.baseUrl;
-    const url = baseUrl + "/api/v1" + resourceUri;
+    const resourceUri = this._httpHelper._config.ResourceUri.UsersMe;
+    const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     const params = [];
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
@@ -2075,6 +2096,18 @@ var DocumentsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  getDocumentWebDavUrl(documentId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentsWebDavUrl.replace("{id}", documentId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, null, null);
+  }
+  getDocumentWopiUrl(documentId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentsWopiUrl.replace("{id}", documentId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, null, null);
+  }
 };
 
 // lib/vvRestApi/projectsManager.js
@@ -2284,66 +2317,11 @@ var VVClient = class {
     this.securityMembers = new SecurityMembersManager(this._httpHelper);
     this.layouts = new LayoutsManager(this._httpHelper);
     this.reports = new ReportsManager(this._httpHelper);
-    this._docApi = null;
-    Object.defineProperties(this, {
-      docApi: {
-        get: function() {
-          if (this._docApi != null && this._docApi.isEnabled && this._docApi.baseUrl) {
-            return this._docApi;
-          } else {
-            throw new ReferenceError("Document Api not enabled");
-          }
-        }
-      }
-    });
-    this._formsApi = null;
-    Object.defineProperties(this, {
-      formsApi: {
-        get: function() {
-          if (this._formsApi != null && this._formsApi.isEnabled && this._formsApi.baseUrl) {
-            return this._formsApi;
-          } else {
-            throw new ReferenceError("Forms Api not enabled");
-          }
-        }
-      }
-    });
-    this._objectsApi = null;
-    Object.defineProperties(this, {
-      objectsApi: {
-        get: function() {
-          if (this._objectsApi != null && this._objectsApi.isEnabled && this._objectsApi.baseUrl) {
-            return this._objectsApi;
-          } else {
-            throw new ReferenceError("Objects Api not enabled");
-          }
-        }
-      }
-    });
-    this._studioApi = null;
-    Object.defineProperties(this, {
-      studioApi: {
-        get: function() {
-          if (this._studioApi != null && this._studioApi.isEnabled && this._studioApi.baseUrl) {
-            return this._studioApi;
-          } else {
-            throw new ReferenceError("Studio Api not enabled");
-          }
-        }
-      }
-    });
-    this._notificationsApi = null;
-    Object.defineProperties(this, {
-      notificationsApi: {
-        get: function() {
-          if (this._notificationsApi != null && this._notificationsApi.isEnabled && this._notificationsApi.baseUrl) {
-            return this._notificationsApi;
-          } else {
-            throw new ReferenceError("Notifications Api not enabled");
-          }
-        }
-      }
-    });
+    this.docApi = null;
+    this.formsApi = null;
+    this.objectsApi = null;
+    this.studioApi = null;
+    this.notificationsApi = null;
   }
   async createDocApi(sessionToken) {
     const docApiConfigResponse = JSON.parse(await this.configuration.getDocApiConfig());
@@ -2352,12 +2330,12 @@ var VVClient = class {
       docApiSession.baseUrl = docApiConfigResponse.data["apiUrl"];
       docApiSession.apiUrl = this.yamlConfig.DocApiUri;
       if (docApiSession["tokenType"] == "jwt") {
-        this._docApi = new DocApi_default(docApiSession, docApiConfigResponse.data);
+        this.docApi = new DocApi_default(docApiSession, docApiConfigResponse.data);
       } else if (this.users) {
         const jwtResponse = JSON.parse(await this.users.getUserJwt(docApiSession.audience));
         if (jwtResponse["data"] && jwtResponse["data"]["token"]) {
           docApiSession.convertToJwt(jwtResponse["data"]);
-          this._docApi = new DocApi_default(docApiSession, docApiConfigResponse.data);
+          this.docApi = new DocApi_default(docApiSession, docApiConfigResponse.data);
         }
       }
     }
@@ -2369,12 +2347,12 @@ var VVClient = class {
       formsApiSession.baseUrl = formsApiConfigResponse.data["formsApiUrl"];
       formsApiSession.apiUrl = this.yamlConfig.FormsApiUri;
       if (formsApiSession["tokenType"] == "jwt") {
-        this._formsApi = new FormsApi_default(formsApiSession, formsApiConfigResponse.data);
+        this.formsApi = new FormsApi_default(formsApiSession, formsApiConfigResponse.data);
       } else if (this.users) {
         const jwtResponse = JSON.parse(await this.users.getUserJwt(formsApiSession.audience));
         if (jwtResponse["data"] && jwtResponse["data"]["token"]) {
           formsApiSession.convertToJwt(jwtResponse["data"]);
-          this._formsApi = new FormsApi_default(formsApiSession, formsApiConfigResponse.data);
+          this.formsApi = new FormsApi_default(formsApiSession, formsApiConfigResponse.data);
         }
       }
     }
@@ -2386,12 +2364,12 @@ var VVClient = class {
       objectsApiSession.baseUrl = objectsApiConfigResponse.data["apiUrl"];
       objectsApiSession.apiUrl = "";
       if (objectsApiSession["tokenType"] == "jwt") {
-        this._objectsApi = new ObjectsApi_default(objectsApiSession, objectsApiConfigResponse.data);
+        this.objectsApi = new ObjectsApi_default(objectsApiSession, objectsApiConfigResponse.data);
       } else if (this.users) {
         const jwtResponse = JSON.parse(await this.users.getUserJwt(objectsApiSession.audience));
         if (jwtResponse["data"] && jwtResponse["data"]["token"]) {
           objectsApiSession.convertToJwt(jwtResponse["data"]);
-          this._objectsApi = new ObjectsApi_default(objectsApiSession, objectsApiConfigResponse.data);
+          this.objectsApi = new ObjectsApi_default(objectsApiSession, objectsApiConfigResponse.data);
         }
       }
     }
@@ -2403,12 +2381,12 @@ var VVClient = class {
       studioApiSession.baseUrl = studioApiConfigResponse.data["studioApiUrl"];
       studioApiSession.apiUrl = "";
       if (studioApiSession["tokenType"] == "jwt") {
-        this._studioApi = new StudioApi_default(studioApiSession, studioApiConfigResponse.data);
+        this.studioApi = new StudioApi_default(studioApiSession, studioApiConfigResponse.data);
       } else if (this.users) {
         const jwtResponse = JSON.parse(await this.users.getUserJwt(studioApiSession.audience));
         if (jwtResponse["data"] && jwtResponse["data"]["token"]) {
           studioApiSession.convertToJwt(jwtResponse["data"]);
-          this._studioApi = new StudioApi_default(studioApiSession, studioApiConfigResponse.data);
+          this.studioApi = new StudioApi_default(studioApiSession, studioApiConfigResponse.data);
         }
       }
     }
@@ -2420,12 +2398,12 @@ var VVClient = class {
       notificationsApiSession.baseUrl = notificationsApiConfigResponse.data["apiUrl"];
       notificationsApiSession.apiUrl = this.yamlConfig.NotificationsApiUri;
       if (notificationsApiSession["tokenType"] == "jwt") {
-        this._notificationsApi = new NotificationsApi_default(notificationsApiSession, notificationsApiConfigResponse.data);
+        this.notificationsApi = new NotificationsApi_default(notificationsApiSession, notificationsApiConfigResponse.data);
       } else if (this.users) {
         const jwtResponse = JSON.parse(await this.users.getUserJwt(notificationsApiSession.audience));
         if (jwtResponse["data"] && jwtResponse["data"]["token"]) {
           notificationsApiSession.convertToJwt(jwtResponse["data"]);
-          this._notificationsApi = new NotificationsApi_default(notificationsApiSession, notificationsApiConfigResponse.data);
+          this.notificationsApi = new NotificationsApi_default(notificationsApiSession, notificationsApiConfigResponse.data);
         }
       }
     }