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

package/dist/VVRestApi.d.cts

@@ -64,7 +64,7 @@ declare class CurrentUserManager {
     getCurrentUser(params?: any): Promise<string>;
 }
 
-declare class DocumentInstanceManager {
+declare class DocumentManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     GetRevision(documentRevisionId: any): Promise<any>;
@@ -79,7 +79,7 @@ declare class DocApi {
     isEnabled: any;
     baseUrl: any;
     roleSecurity: any;
-    documentInstances: DocumentInstanceManager;
+    documents: DocumentManager;
 }
 
 declare class FormInstanceManager {
@@ -97,7 +97,7 @@ declare class FormsApi {
     formInstances: FormInstanceManager;
 }
 
-declare class ModelsManager {
+declare class ModelManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     /**
@@ -113,7 +113,7 @@ declare class ModelsManager {
     getModelById(modelId: string, params: object): Promise<any>;
 }
 
-declare class ObjectsManager {
+declare class ObjectManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     /**
@@ -157,8 +157,8 @@ declare class ObjectsApi {
     _httpHelper: HttpHelper;
     isEnabled: any;
     baseUrl: any;
-    models: ModelsManager;
-    objects: ObjectsManager;
+    models: ModelManager;
+    objects: ObjectManager;
 }
 
 declare class WorkflowManager {
@@ -205,12 +205,23 @@ declare class WorkflowManager {
     GetRunningWorkflowForObject(objectId: string, workflowId: string): Promise<any>;
 }
 
+declare class RolesAndPermissionsManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    /**
+     * Retrieves available features for the requesting user
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getUserFeatures(params: object): Promise<any>;
+}
+
 declare class StudioApi {
     constructor(sessionToken: any, studioApiConfig: any);
     _httpHelper: HttpHelper;
     isEnabled: any;
     baseUrl: any;
     workflow: WorkflowManager;
+    permissions: RolesAndPermissionsManager;
 }
 
 declare class UserNotificationsManager {
@@ -305,11 +316,11 @@ declare class VVClient {
     yamlConfig: any;
     _httpHelper: HttpHelper;
     currentUser: CurrentUserManager;
-    _docApi: DocApi;
-    _formsApi: FormsApi;
-    _objectsApi: ObjectsApi;
-    _studioApi: StudioApi;
-    _notificationsApi: NotificationsApi;
+    docApi: DocApi;
+    formsApi: FormsApi;
+    objectsApi: ObjectsApi;
+    studioApi: StudioApi;
+    notificationsApi: NotificationsApi;
     createDocApi(sessionToken: any): Promise<void>;
     createFormsApi(sessionToken: any): Promise<void>;
     createObjectsApi(sessionToken: any): Promise<void>;

package/dist/VVRestApi.d.ts

@@ -64,7 +64,7 @@ declare class CurrentUserManager {
     getCurrentUser(params?: any): Promise<string>;
 }
 
-declare class DocumentInstanceManager {
+declare class DocumentManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     GetRevision(documentRevisionId: any): Promise<any>;
@@ -79,7 +79,7 @@ declare class DocApi {
     isEnabled: any;
     baseUrl: any;
     roleSecurity: any;
-    documentInstances: DocumentInstanceManager;
+    documents: DocumentManager;
 }
 
 declare class FormInstanceManager {
@@ -97,7 +97,7 @@ declare class FormsApi {
     formInstances: FormInstanceManager;
 }
 
-declare class ModelsManager {
+declare class ModelManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     /**
@@ -113,7 +113,7 @@ declare class ModelsManager {
     getModelById(modelId: string, params: object): Promise<any>;
 }
 
-declare class ObjectsManager {
+declare class ObjectManager {
     constructor(httpHelper: any);
     _httpHelper: any;
     /**
@@ -157,8 +157,8 @@ declare class ObjectsApi {
     _httpHelper: HttpHelper;
     isEnabled: any;
     baseUrl: any;
-    models: ModelsManager;
-    objects: ObjectsManager;
+    models: ModelManager;
+    objects: ObjectManager;
 }
 
 declare class WorkflowManager {
@@ -205,12 +205,23 @@ declare class WorkflowManager {
     GetRunningWorkflowForObject(objectId: string, workflowId: string): Promise<any>;
 }
 
+declare class RolesAndPermissionsManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    /**
+     * Retrieves available features for the requesting user
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getUserFeatures(params: object): Promise<any>;
+}
+
 declare class StudioApi {
     constructor(sessionToken: any, studioApiConfig: any);
     _httpHelper: HttpHelper;
     isEnabled: any;
     baseUrl: any;
     workflow: WorkflowManager;
+    permissions: RolesAndPermissionsManager;
 }
 
 declare class UserNotificationsManager {
@@ -305,11 +316,11 @@ declare class VVClient {
     yamlConfig: any;
     _httpHelper: HttpHelper;
     currentUser: CurrentUserManager;
-    _docApi: DocApi;
-    _formsApi: FormsApi;
-    _objectsApi: ObjectsApi;
-    _studioApi: StudioApi;
-    _notificationsApi: NotificationsApi;
+    docApi: DocApi;
+    formsApi: FormsApi;
+    objectsApi: ObjectsApi;
+    studioApi: StudioApi;
+    notificationsApi: NotificationsApi;
     createDocApi(sessionToken: any): Promise<void>;
     createFormsApi(sessionToken: any): Promise<void>;
     createObjectsApi(sessionToken: any): Promise<void>;

package/dist/VVRestApi.js

@@ -574,9 +574,9 @@ var common_default = {
   authorize: Authorize
 };
 
-// lib/docApi/documentInstanceManager.js
+// lib/docApi/documentManager.js
 init_esm_shims();
-var DocumentInstanceManager = class {
+var DocumentManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -637,7 +637,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);
     }
   }
 };
@@ -696,9 +696,9 @@ var FormsApi_default = FormsApi;
 // lib/ObjectsApi.js
 init_esm_shims();
 
-// lib/objectsApi/modelsManager.js
+// lib/objectsApi/modelManager.js
 init_esm_shims();
-var ModelsManager = class {
+var ModelManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -727,11 +727,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_esm_shims();
-var ObjectsManager = class {
+var ObjectManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
@@ -809,7 +809,7 @@ var ObjectsManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
 };
-var objectsManager_default = ObjectsManager;
+var objectManager_default = ObjectManager;
 
 // lib/ObjectsApi.js
 import yaml4 from "js-yaml";
@@ -828,8 +828,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);
     }
   }
 };
@@ -938,6 +938,27 @@ var WorkflowManager = class {
 };
 var workflowManager_default = WorkflowManager;
 
+// lib/studioApi/rolesAndPermissionsManager.js
+init_esm_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
 import yaml5 from "js-yaml";
 import fs5 from "fs";
@@ -956,6 +977,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);
     }
   }
 };
@@ -1743,9 +1765,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);
@@ -2041,6 +2062,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
@@ -2250,66 +2283,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());
@@ -2318,12 +2296,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);
         }
       }
     }
@@ -2335,12 +2313,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);
         }
       }
     }
@@ -2352,12 +2330,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);
         }
       }
     }
@@ -2369,12 +2347,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);
         }
       }
     }
@@ -2386,12 +2364,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);
         }
       }
     }