Skip to content

v2.0.0

Latest

Choose a tag to compare

@VV-Jon-Brown VV-Jon-Brown released this 10 Apr 20:00
· 6 commits to main since this release
9f58aa7

Added

  • ES module support with CommonJS compatibility
  • TypeScript definitions for better IDE support
  • Comprehensive documentation in README
  • Proper .npmignore to reduce package size
  • Vitest test framework
  • Add CurrentUserManager
  • Add DropdownListsManager
  • Add LanguageResourceManager
  • New Methods in DocumentsManager, GroupsManager, IndexFieldsManager, LibraryManager, ReportsManager, SitesManager
  • Add getDocumentWebDavUrl and getDocumentWopiUrl methods
  • Add addIndexFieldToFolder method

Changed

  • BREAKING: Updated client so that DocApi and ObjectsApi methods have individual namespaces
  • BREAKING: Class authorize renamed to Authorize to follow JavaScript PascalCase convention for classes (use new vvRestApi.Authorize() instead of new vvRestApi.authorize())
  • BREAKING: Extended API modules (docApi, formsApi, objectsApi, studioApi, notificationsApi) now return null when not enabled instead of throwing ReferenceError on access. Check availability with if (client.docApi) or use optional chaining client.docApi?.method().
  • BREAKING: IndexFieldsManager.putIndexFields() renamed to addIndexFieldToFolder() (same parameters, new name)
  • BREAKING: FormsManager.returnField() now returns a new ReturnField object instead of setting properties on the manager instance. Code that read client.forms.id or client.forms.name after calling returnField() must use the returned object instead.
  • BREAKING: Q promise library replaced with native Promises. Code using Q-specific methods (.fail(), .fin(), .progress()) on returned promises must migrate to standard .catch() / .finally().
  • BREAKING: request npm module replaced with native fetch(). Proxy support via environment variables or request-specific behaviors (cookie jars, redirect handling) may differ.
  • Replaced console.log calls during authentication with debug library (silent by default, enable with DEBUG=visualvault:*).

Removed

  • Express server components (app.js, routes/, views/, public/)
  • Server-specific dependencies
  • Sample scripts (available in separate microservices repository)
  • Development files and runtime artifacts

Full Changelog: https://github.com/VisualVault/vv-rest-api-node/commits/v2.0.0