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

package/LICENSE

@@ -1,21 +1,15 @@
-MIT License
+ISC License
 
-Copyright (c) 2025 VisualVault
+Copyright (c) 2025, VisualVault
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,148 +1,148 @@
-# visualvault-api
-
-![Stability: Beta](https://img.shields.io/badge/stability-beta-yellow.svg)
-
-A Node.js client library that provides convenient access to the VisualVault REST API for server-side applications.
-
-## Installation
-
-```bash
-npm install visualvault-api
-```
-
-## Requirements
-
-- Node.js 20.0.0 or higher
-
-## Quick Start
-
-### Basic Authentication and Setup
-
-```javascript
-// ES Modules (recommended)
-import vvRestApi from 'visualvault-api';
-
-// CommonJS
-const vvRestApi = require('visualvault-api');
-
-// Initialize authentication
-const auth = new vvRestApi.authorize();
-
-// Get authenticated client
-auth.getVaultApi(
-    'your-client-id',
-    'your-client-secret',
-    'username',
-    'password',
-    'your-audience',
-    'https://your-vault-url.com',
-    'customer-alias',
-    'database-alias'
-).then(client => {
-    console.log('Successfully authenticated!');
-    // Use the client for API calls
-}).catch(error => {
-    console.error('Authentication failed:', error);
-});
-```
-
-### JWT Authentication
-
-If you already have a JWT token:
-
-```javascript
-const auth = new vvRestApi.authorize();
-
-auth.getVaultApiFromJwt(
-    'your-jwt-token',
-    'https://your-vault-url.com',
-    'customer-alias',
-    'database-alias',
-    new Date('2024-12-31') // expiration date
-).then(client => {
-    console.log('JWT authentication successful!');
-}).catch(error => {
-    console.error('JWT authentication failed:', error);
-});
-```
-
-## API Usage
-
-Once authenticated, the client provides access to various API modules. All methods return Promises.
-
-```javascript
-// Example: Get forms by template name
-client.forms.getForms(params, 'Your Form Template Name')
-    .then(response => {
-        const forms = JSON.parse(response);
-        console.log('Forms:', forms.data);
-    });
-
-// Example: Execute a web service
-client.scripts.runWebService('YourWebServiceName', { param1: 'value1' })
-    .then(response => {
-        console.log('Web service result:', response);
-    });
-```
-
-## API Modules
-
-The client provides access to the following VisualVault API modules:
-
-- **documents** - Document management operations
-- **forms** - Form template and instance operations
-- **library** - Folder and library management
-- **users** - User management operations
-- **groups** - Group management operations
-- **sites** - Site management operations
-- **files** - File upload/download operations
-- **scripts** - Web service execution
-- **customQuery** - Custom query execution
-- **email** - Email operations
-- **constants** - API constants and enums
-- **scheduledProcess** - Scheduled process management
-- **customer** - Customer management operations
-- **projects** - Project management operations
-- **indexFields** - Document Index field operations
-- **outsideProcesses** - Outside process management
-- **securityMembers** - Security member management
-- **reports** - Report generation
-
-## Extended API Modules
-
-When enabled, the following additional API modules are available:
-
-- **docApi** - Enhanced document operations
-- **formsApi** - Enhanced forms operations
-- **objectsApi** - Object model operations
-- **studioApi** - Workflow and studio operations
-- **notificationsApi** - Real-time notifications
-
-## Error Handling
-
-```javascript
-client.documents.getDocuments(params, folderId)
-    .then(response => {
-        const result = JSON.parse(response);
-        if (result.meta && result.meta.statusCode === 200) {
-            console.log('Success:', result.data);
-        } else {
-            console.error('API Error:', result);
-        }
-    })
-    .catch(error => {
-        console.error('Request failed:', error);
-    });
-```
-
-## Support
-
-For more information about the VisualVault API, visit the [VisualVault documentation](https://docs.visualvault.com/).
-
-## License
-
-This project is licensed under the [MIT License](LICENSE).
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+# visualvault-api
+
+![Stability: Beta](https://img.shields.io/badge/stability-beta-yellow.svg)
+
+A Node.js client library that provides convenient access to the VisualVault REST API for server-side applications.
+
+## Installation
+
+```bash
+npm install visualvault-api
+```
+
+## Requirements
+
+- Node.js 20.0.0 or higher
+
+## Quick Start
+
+### Basic Authentication and Setup
+
+```javascript
+// ES Modules (recommended)
+import vvRestApi from 'visualvault-api';
+
+// CommonJS
+const vvRestApi = require('visualvault-api');
+
+// Initialize authentication
+const auth = new vvRestApi.authorize();
+
+// Get authenticated client
+auth.getVaultApi(
+    'your-client-id',
+    'your-client-secret',
+    'username',
+    'password',
+    'your-audience',
+    'https://your-vault-url.com',
+    'customer-alias',
+    'database-alias'
+).then(client => {
+    console.log('Successfully authenticated!');
+    // Use the client for API calls
+}).catch(error => {
+    console.error('Authentication failed:', error);
+});
+```
+
+### JWT Authentication
+
+If you already have a JWT token:
+
+```javascript
+const auth = new vvRestApi.authorize();
+
+auth.getVaultApiFromJwt(
+    'your-jwt-token',
+    'https://your-vault-url.com',
+    'customer-alias',
+    'database-alias',
+    new Date('2024-12-31') // expiration date
+).then(client => {
+    console.log('JWT authentication successful!');
+}).catch(error => {
+    console.error('JWT authentication failed:', error);
+});
+```
+
+## API Usage
+
+Once authenticated, the client provides access to various API modules. All methods return Promises.
+
+```javascript
+// Example: Get forms by template name
+client.forms.getForms(params, 'Your Form Template Name')
+    .then(response => {
+        const forms = JSON.parse(response);
+        console.log('Forms:', forms.data);
+    });
+
+// Example: Execute a web service
+client.scripts.runWebService('YourWebServiceName', { param1: 'value1' })
+    .then(response => {
+        console.log('Web service result:', response);
+    });
+```
+
+## API Modules
+
+The client provides access to the following VisualVault API modules:
+
+- **documents** - Document management operations
+- **forms** - Form template and instance operations
+- **library** - Folder and library management
+- **users** - User management operations
+- **groups** - Group management operations
+- **sites** - Site management operations
+- **files** - File upload/download operations
+- **scripts** - Web service execution
+- **customQuery** - Custom query execution
+- **email** - Email operations
+- **constants** - API constants and enums
+- **scheduledProcess** - Scheduled process management
+- **customer** - Customer management operations
+- **projects** - Project management operations
+- **indexFields** - Document Index field operations
+- **outsideProcesses** - Outside process management
+- **securityMembers** - Security member management
+- **reports** - Report generation
+
+## Extended API Modules
+
+When enabled, the following additional API modules are available:
+
+- **docApi** - Enhanced document operations
+- **formsApi** - Enhanced forms operations
+- **objectsApi** - Object model operations
+- **studioApi** - Workflow and studio operations
+- **notificationsApi** - Real-time notifications
+
+## Error Handling
+
+```javascript
+client.documents.getDocuments(params, folderId)
+    .then(response => {
+        const result = JSON.parse(response);
+        if (result.meta && result.meta.statusCode === 200) {
+            console.log('Success:', result.data);
+        } else {
+            console.error('API Error:', result);
+        }
+    })
+    .catch(error => {
+        console.error('Request failed:', error);
+    });
+```
+
+## Support
+
+For more information about the VisualVault API, visit the [VisualVault documentation](https://docs.visualvault.com/).
+
+## License
+
+This project is licensed under the [ISC License](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

package/dist/VVRestApi.cjs

@@ -604,9 +604,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;
   }
@@ -667,7 +667,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);
     }
   }
 };
@@ -726,9 +726,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;
   }
@@ -757,11 +757,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;
   }
@@ -839,7 +839,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);
@@ -858,8 +858,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);
     }
   }
 };
@@ -968,6 +968,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);
@@ -986,6 +1007,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);
     }
   }
 };
@@ -1773,9 +1795,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);
@@ -2071,6 +2092,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
@@ -2280,66 +2313,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());
@@ -2348,12 +2326,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);
         }
       }
     }
@@ -2365,12 +2343,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);
         }
       }
     }
@@ -2382,12 +2360,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);
         }
       }
     }
@@ -2399,12 +2377,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);
         }
       }
     }
@@ -2416,12 +2394,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);
         }
       }
     }