visualvault-api 1.2.0 → 2.0.0-beta.2

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2025, VisualVault
+
+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 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,5 +1,7 @@
 # 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
@@ -17,6 +19,10 @@ npm install visualvault-api
 ### Basic Authentication and Setup
 
 ```javascript
+// ES Modules (recommended)
+import vvRestApi from 'visualvault-api';
+
+// CommonJS
 const vvRestApi = require('visualvault-api');
 
 // Initialize authentication
@@ -60,150 +66,20 @@ auth.getVaultApiFromJwt(
 });
 ```
 
-## API Usage Examples
-
-### Working with Documents
-
-```javascript
-// Get documents from a folder
-client.library.getDocuments(params, folderId)
-    .then(response => {
-        const documents = JSON.parse(response);
-        console.log('Documents:', documents.data);
-    });
-
-// Upload a new document
-const documentData = {
-    fileName: 'example.pdf',
-    description: 'Example document',
-    folderId: 'your-folder-id'
-};
+## API Usage
 
-client.documents.postDocWithFile(documentData, fileBuffer)
-    .then(response => {
-        console.log('Document uploaded:', response);
-    });
-
-// Get document details
-client.documents.getDocumentRevision(params, revisionId)
-    .then(response => {
-        const document = JSON.parse(response);
-        console.log('Document details:', document);
-    });
-```
-
-### Working with Forms
+Once authenticated, the client provides access to various API modules. All methods return Promises.
 
 ```javascript
-// Get forms by template name
+// 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);
     });
 
-// Create a new form instance
-const formData = {
-    field1: 'value1',
-    field2: 'value2'
-};
-
-client.forms.postForms(params, formData, 'Your Form Template Name')
-    .then(response => {
-        console.log('Form created:', response);
-    });
-
-// Get form instance by ID
-client.forms.getFormInstanceById(templateId, instanceId)
-    .then(response => {
-        const form = JSON.parse(response);
-        console.log('Form instance:', form);
-    });
-```
-
-### Working with Folders
-
-```javascript
-// Get folders
-client.library.getFolders(params)
-    .then(response => {
-        const folders = JSON.parse(response);
-        console.log('Folders:', folders.data);
-    });
-
-// Create a new folder
-const folderData = {
-    name: 'New Folder',
-    description: 'Folder description'
-};
-
-client.library.postFolderByPath(params, folderData, '/Parent Folder/New Folder')
-    .then(response => {
-        console.log('Folder created:', response);
-    });
-```
-
-### Working with Users
-
-```javascript
-// Get current user information
-client.users.getUser(params)
-    .then(response => {
-        const user = JSON.parse(response);
-        console.log('Current user:', user);
-    });
-
-// Get users in a site
-client.users.getUsers(params, siteId)
-    .then(response => {
-        const users = JSON.parse(response);
-        console.log('Users:', users.data);
-    });
-```
-
-### Running Custom Queries
-
-```javascript
-// Execute a custom query by name
-client.customQuery.getCustomQueryResultsByName('Your Query Name', params)
-    .then(response => {
-        const results = JSON.parse(response);
-        console.log('Query results:', results.data);
-    });
-```
-
-### Working with Files
-
-```javascript
-// Upload a file
-const fileData = {
-    fileName: 'document.pdf',
-    description: 'My document'
-};
-
-client.files.postFile(fileData, fileBuffer)
-    .then(response => {
-        console.log('File uploaded:', response);
-    });
-
-// Download a file
-client.files.getFileBytesId(fileId)
-    .then(fileBuffer => {
-        // Process the file buffer
-        console.log('File downloaded, size:', fileBuffer.length);
-    });
-```
-
-### Running Web Services
-
-```javascript
-// Execute a web service
-const serviceData = {
-    param1: 'value1',
-    param2: 'value2'
-};
-
-client.scripts.runWebService('YourWebServiceName', serviceData)
+// Example: Execute a web service
+client.scripts.runWebService('YourWebServiceName', { param1: 'value1' })
     .then(response => {
         console.log('Web service result:', response);
     });
@@ -232,6 +108,15 @@ The client provides access to the following VisualVault API modules:
 - **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
 
@@ -254,12 +139,10 @@ client.documents.getDocuments(params, folderId)
 
 For more information about the VisualVault API, visit the [VisualVault documentation](https://docs.visualvault.com/).
 
-For VisualVault micro service debugging assistance see [Readme-microservices](https://github.com/VisualVault/nodeJs-rest-client-library/blob/master/Readme-microservices.md).
-
 ## License
 
-Use of the VisualVault API requires a customer hosting contract which defines all license terms.
+This project is licensed under the [ISC License](LICENSE).
 
-## Repository
+## Contributing
 
-[GitHub Repository](https://github.com/VisualVault/nodeJs-rest-client-library)
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.