@open-xchange/soap-client 0.0.11 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,84 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-15
+
+### Changed
+
+- Replace chalk and dotenv with Node.js built-ins
+- Clean up dependencies, packaging, and config files
+
+## [0.0.12] - 2026-02-25
+
+### Fixed
+
+- Lazy-init SOAP clients to avoid WSDL fetches at import time
+
+## [0.0.11] - 2026-02-24
+
+### Added
+
+- Support for shared accounts in e2e tests
+
+## [0.0.10] - 2026-01-22
+
+### Added
+
+- Exponential backoff with jitter to SOAP client retries
+
+## [0.0.9] - 2025-12-12
+
+### Changed
+
+- Update dependencies
+
+## [0.0.8] - 2025-09-30
+
+### Fixed
+
+- Unhandled rejection timeout errors in soap-client
+
+## [0.0.7] - 2025-09-12
+
+### Added
+
+- Set access combination when provisioning
+
+## [0.0.6] - 2025-09-02
+
+### Fixed
+
+- Correctly identify already existing users when provisioning
+
+## [0.0.5] - 2025-08-18
+
+### Changed
+
+- Update provisioning script
+
+## [0.0.4] - 2025-07-28
+
+### Changed
+
+- Increase SOAP client timeout
+
+## [0.0.3] - 2025-07-18
+
+### Removed
+
+- Secondary account service from reseller
+
+## [0.0.2] - 2025-07-18
+
+### Changed
+
+- Update dependencies
+
+## [0.0.1] - 2025-02-28
+
+### Added
+
+- Initial release: extract SOAP client into its own library

package/bin/provision.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 import fs from 'node:fs'
 import { program } from 'commander'
-import dotenv from 'dotenv'
 import * as secondaryAccountService from '../services/secondaryAccount.js'
 import * as userService from '../services/common/user.js'
 import * as contextService from '../services/common/context.js'
 
-dotenv.config({ path: ['.env', '.env.defaults'], quiet: true })
+for (const envFile of ['.env', '.env.defaults']) {
+  try { process.loadEnvFile(envFile) } catch {}
+}
 
 const contextAdmin = {
   admin: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",
@@ -20,13 +20,12 @@
   "author": "",
   "license": "AGPL-3.0-or-later",
   "dependencies": {
-    "commander": "^14.0.2",
-    "dotenv": "^17.2.3",
+    "commander": "^14.0.3",
     "p-retry": "^7.1.1",
-    "soap": "^1.6.1"
+    "soap": "^1.8.0"
   },
   "devDependencies": {
-    "@open-xchange/lint": "0.2.1"
+    "@open-xchange/lint": "0.3.0"
   },
   "scripts": {
     "lint": "eslint .",

package/services/common/context.js

@@ -20,14 +20,18 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXContextService = createClientAsync('OXContextService')
+let OXContextService
+function getClient () {
+  if (!OXContextService) OXContextService = createClientAsync('OXContextService')
+  return OXContextService
+}
 
 /**
  * This function retrieves the default context from the OXContextService.
  * @returns {Promise<Object>} The first result from the listAsync method call.
  */
 export async function getDefault () {
-  return (await OXContextService).listAsync({ search_pattern: 'defaultcontext' })[0]
+  return (await getClient()).listAsync({ search_pattern: 'defaultcontext' })[0]
 }
 
 /**
@@ -36,7 +40,7 @@ export async function getDefault () {
  * @param {number} id The ID of the context to remove.
  */
 export async function remove (id) {
-  return (await OXContextService).deleteAsync({ ctx: { id } })
+  return (await getClient()).deleteAsync({ ctx: { id } })
 }
 
 /**
@@ -59,7 +63,7 @@ export async function remove (id) {
  * @returns {Promise<Object>} The created context.
  */
 export async function create (ctx = {}, adminUser = {}, accessCombinationName = 'all') {
-  return (await OXContextService)
+  return (await getClient())
     .createAsync({
       ctx,
       admin_user: Object.assign({
@@ -91,7 +95,7 @@ export async function create (ctx = {}, adminUser = {}, accessCombinationName =
 // eslint-disable-next-line camelcase
 export async function changeModuleAccessByName (id, access_combination_name) {
   // eslint-disable-next-line camelcase
-  return (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
+  return (await getClient()).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
 }
 
 /**
@@ -105,7 +109,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
   const data = {}
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return (await OXContextService).changeCapabilitiesAsync({ ctx: { id }, ...data })
+  return (await getClient()).changeCapabilitiesAsync({ ctx: { id }, ...data })
 }
 
 /**
@@ -114,7 +118,7 @@ export async function changeCapabilities (id, capsToAdd, capsToRemove) {
  * @returns {Promise<Object>} The module access of the specified context.
  */
 export async function getModuleAccess (id) {
-  return (await OXContextService).getModuleAccessAsync({ ctx: { id } })
+  return (await getClient()).getModuleAccessAsync({ ctx: { id } })
 }
 /**
  * This function changes the module access of the specified context.
@@ -124,7 +128,7 @@ export async function getModuleAccess (id) {
  */
 export async function changeModuleAccess (id, moduleAccess) {
   const currentAccess = await getModuleAccess(id)
-  return (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
+  return (await getClient()).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
 }
 
 /**
@@ -135,7 +139,7 @@ export async function changeModuleAccess (id, moduleAccess) {
  * @returns {Promise<Array<Object>>} The list of contexts that match the search pattern.
  */
 export async function list (searchPattern, { excludeDisabled } = { excludeDisabled: true }) {
-  return (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled }).catch(e => {
+  return (await getClient()).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled }).catch(e => {
     logSoapError(e)
     return []
   })
@@ -147,7 +151,7 @@ export async function list (searchPattern, { excludeDisabled } = { excludeDisabl
  * @returns {Promise<Object>} The context with the specified ID.
  */
 export async function get (id) {
-  return (await OXContextService).getDataAsync({ ctx: { id } })
+  return (await getClient()).getDataAsync({ ctx: { id } })
 }
 
 /**
@@ -156,5 +160,5 @@ export async function get (id) {
  * @returns {Promise<void>}
  */
 export async function change (ctx) {
-  return (await OXContextService).changeAsync({ ctx })
+  return (await getClient()).changeAsync({ ctx })
 }

package/services/common/user.js

@@ -20,7 +20,11 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXUserService = createClientAsync('OXUserService')
+let OXUserService
+function getClient () {
+  if (!OXUserService) OXUserService = createClientAsync('OXUserService')
+  return OXUserService
+}
 
 /**
  * This function removes the user with the specified context and user ID.
@@ -29,7 +33,7 @@ const OXUserService = createClientAsync('OXUserService')
  * @returns {Promise<Boolean>} Returns true if it could remove the user and false if it could not
  */
 export async function remove (context, userId) {
-  return (await OXUserService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -43,7 +47,7 @@ export async function remove (context, userId) {
  * @returns {Promise<Object>} The created user.
  */
 export async function create (context, usrdata) {
-  return (await OXUserService).createAsync({
+  return (await getClient()).createAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -57,7 +61,7 @@ export async function create (context, usrdata) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return (await OXUserService).changeAsync({
+  return (await getClient()).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: context.admin
@@ -65,7 +69,7 @@ export async function change (context, usrdata) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return (await OXUserService).changeByModuleAccessAsync({
+  return (await getClient()).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -74,7 +78,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return (await OXUserService).changeByModuleAccessNameAsync({
+  return (await getClient()).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -83,7 +87,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function getModuleAccess (context, userId) {
-  return (await OXUserService).getModuleAccessAsync({
+  return (await getClient()).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -100,11 +104,11 @@ export async function changeCapabilities (context, userId, capsToAdd, capsToRemo
   }
   if (capsToAdd) data.capsToAdd = capsToAdd
   if (capsToRemove) data.capsToRemove = capsToRemove
-  return (await OXUserService).changeCapabilitiesAsync(data)
+  return (await getClient()).changeCapabilitiesAsync(data)
 }
 
 export async function exists (context, userId) {
-  return (await OXUserService).existsAsync({
+  return (await getClient()).existsAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: context.admin
@@ -112,7 +116,7 @@ export async function exists (context, userId) {
 }
 
 export async function list (context, searchPattern, includeGuests = false) {
-  return (await OXUserService).listAsync({
+  return (await getClient()).listAsync({
     ctx: { id: context.id },
     search_pattern: searchPattern,
     include_guests: includeGuests,
@@ -121,7 +125,7 @@ export async function list (context, searchPattern, includeGuests = false) {
 }
 
 export async function listAll (context, includeGuests = false, excludeUsers = []) {
-  return (await OXUserService).listAsync({
+  return (await getClient()).listAsync({
     ctx: { id: context.id },
     include_guests: includeGuests,
     exclude_users: excludeUsers,

package/services/reseller/oxaas.js

@@ -20,12 +20,16 @@
 
 import { createClientAsync } from '../../soap.js'
 
-const OXaaSService = createClientAsync('OXaaSService').then(client => client)
+let OXaaSService
+function getClient () {
+  if (!OXaaSService) OXaaSService = createClientAsync('OXaaSService')
+  return OXaaSService
+}
 
 export async function setMailQuota (data) {
-  return (await OXaaSService).setMailQuotaAsync(data)
+  return (await getClient()).setMailQuotaAsync(data)
 }
 
 export async function createSharedDomain (data) {
-  return (await OXaaSService).createSharedDomain(data)
+  return (await getClient()).createSharedDomain(data)
 }

package/services/reseller/resellerContext.js

@@ -20,36 +20,40 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXResellerContextService = createClientAsync('OXResellerContextService')
+let OXResellerContextService
+function getClient () {
+  if (!OXResellerContextService) OXResellerContextService = createClientAsync('OXResellerContextService')
+  return OXResellerContextService
+}
 
 export async function create (data) {
-  return (await OXResellerContextService).createAsync(data)
+  return (await getClient()).createAsync(data)
 }
 
 export async function remove (contextId) {
-  return (await OXResellerContextService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: contextId }
   }).catch(logSoapError)
 }
 
 export async function change (ctx) {
-  return (await OXResellerContextService).changeAsync({ ctx })
+  return (await getClient()).changeAsync({ ctx })
 }
 
 export async function get (id) {
-  return (await OXResellerContextService).getDataAsync({ ctx: { id } })
+  return (await getClient()).getDataAsync({ ctx: { id } })
 }
 
 export async function getModuleAccess (id) {
-  return (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
+  return (await getClient()).getModuleAccessAsync({ ctx: id })
 }
 
 export async function changeModuleAccess (id, access) {
   const currentAccess = await getModuleAccess(id)
 
-  return (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
+  return (await getClient()).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
 }
 
 export async function listAll (data) {
-  return (await OXResellerContextService).listAllAsync(data)
+  return (await getClient()).listAllAsync(data)
 }

package/services/reseller/resellerUser.js

@@ -20,10 +20,14 @@
 
 import { createClientAsync, logSoapError } from '../../soap.js'
 
-const OXResellerUserService = createClientAsync('OXResellerUserService').then(client => client)
+let OXResellerUserService
+function getClient () {
+  if (!OXResellerUserService) OXResellerUserService = createClientAsync('OXResellerUserService')
+  return OXResellerUserService
+}
 
 export async function remove (contextId, userId) {
-  return (await OXResellerUserService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: contextId },
     user: { id: userId }
   }).catch(logSoapError)
@@ -36,7 +40,7 @@ export async function remove (contextId, userId) {
  * @returns {Promise<void>}
  */
 export async function change (context, usrdata) {
-  return (await OXResellerUserService).changeAsync({
+  return (await getClient()).changeAsync({
     ctx: { id: context.id },
     usrdata,
     auth: { login: context.admin.name, password: context.admin.password }
@@ -44,11 +48,11 @@ export async function change (context, usrdata) {
 }
 
 export async function get (data) {
-  return (await OXResellerUserService).getDataAsync(data)
+  return (await getClient()).getDataAsync(data)
 }
 
 export async function getModuleAccess (context, userId) {
-  return (await OXResellerUserService).getModuleAccessAsync({
+  return (await getClient()).getModuleAccessAsync({
     ctx: { id: context.id },
     user: { id: userId },
     auth: { login: context.admin.name, password: context.admin.password }
@@ -58,7 +62,7 @@ export async function getModuleAccess (context, userId) {
 }
 
 export async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
-  return (await OXResellerUserService).changeByModuleAccessAsync({
+  return (await getClient()).changeByModuleAccessAsync({
     ctx: { id: context.id },
     moduleAccess: Object.assign({}, currentAccess, moduleAccess),
     user: { id: userId },
@@ -67,7 +71,7 @@ export async function changeByModuleAccess (context, userId, currentAccess, modu
 }
 
 export async function changeByModuleAccessName (context, userId, accessCombinationName) {
-  return (await OXResellerUserService).changeByModuleAccessNameAsync({
+  return (await getClient()).changeByModuleAccessNameAsync({
     ctx: { id: context.id },
     access_combination_name: accessCombinationName,
     user: { id: userId },
@@ -76,7 +80,7 @@ export async function changeByModuleAccessName (context, userId, accessCombinati
 }
 
 export async function createByModuleAccessName (context, usrdata) {
-  return (await OXResellerUserService).createByModuleAccessNameAsync({
+  return (await getClient()).createByModuleAccessNameAsync({
     ctx: { id: context.id },
     usrdata,
     access_combination_name: 'all',
@@ -85,5 +89,5 @@ export async function createByModuleAccessName (context, usrdata) {
 }
 
 export async function listAll (data) {
-  return await (await OXResellerUserService).listAllAsync(data)
+  return await (await getClient()).listAllAsync(data)
 }

package/services/secondaryAccount.js

@@ -1,6 +1,10 @@
 import { createClientAsync } from '../soap.js'
 
-const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
+let OXSecondaryAccountService
+function getClient () {
+  if (!OXSecondaryAccountService) OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
+  return OXSecondaryAccountService
+}
 
 /**
  * Creates a secondary account using the OX Secondary Account Service
@@ -13,7 +17,7 @@ const OXSecondaryAccountService = createClientAsync('OXSecondaryAccountService')
  * @throws {Error} If the account creation fails
  */
 export async function create (accountData, context, users = [], groups = []) {
-  return (await OXSecondaryAccountService).createAsync({
+  return (await getClient()).createAsync({
     accountDataOnCreate: accountData,
     context: { id: context.id },
     users: users || [],
@@ -22,13 +26,13 @@ export async function create (accountData, context, users = [], groups = []) {
 }
 
 export async function list (context) {
-  return (await OXSecondaryAccountService).listAsync({
+  return (await getClient()).listAsync({
     context: { id: context.id },
     auth: context.admin
   })
 }
 export async function remove (primaryAddress, context, users, groups) {
-  return (await OXSecondaryAccountService).deleteAsync({
+  return (await getClient()).deleteAsync({
     primaryAddress,
     context: { id: context.id },
     users,
@@ -37,7 +41,7 @@ export async function remove (primaryAddress, context, users, groups) {
 }
 
 export async function update (primaryAddress, accountData, context, users, groups) {
-  return (await OXSecondaryAccountService).updateAsync({
+  return (await getClient()).updateAsync({
     primaryAddress,
     accountDataUpdate: accountData,
     context: { id: context.id },

package/services/sharedAccount.js

@@ -20,7 +20,11 @@
 
 import { createClientAsync } from '../soap.js'
 
-const OXSharedAccountService = createClientAsync('OXSharedAccountService')
+let OXSharedAccountService
+function getClient () {
+  if (!OXSharedAccountService) OXSharedAccountService = createClientAsync('OXSharedAccountService')
+  return OXSharedAccountService
+}
 
 /**
  * Creates a shared account using the OX Shared Account Service
@@ -31,7 +35,7 @@ const OXSharedAccountService = createClientAsync('OXSharedAccountService')
  * @throws {Error} If the shared account creation fails
  */
 export async function create (context, sharedAccountData) {
-  return (await OXSharedAccountService).createAsync({
+  return (await getClient()).createAsync({
     ctx: { id: context.id },
     sharedAccountData,  // display_name, given_name, imapServer, language, mailenabled, name, sur_name, primaryEmail, email1, smtpServer, timezone, password
     auth: context.admin
@@ -52,7 +56,7 @@ export async function create (context, sharedAccountData) {
  * @throws {Error} If the creation of the shared account permissions fails
  */
 export async function createSharedAccountPermissions (context, sharedAccountContext, sharedAccountData, mailConfig, calendarConfig, users = [], groups = []) {
-  return (await OXSharedAccountService).createSharedAccountPermissionsAsync({
+  return (await getClient()).createSharedAccountPermissionsAsync({
     ctx: { id: context.id },
     groups,
     users: users.map(user => { return { id: user.userdata.id } }),
@@ -72,7 +76,7 @@ export async function createSharedAccountPermissions (context, sharedAccountCont
  * @returns {Promise<Object[]>} The list of shared account objects
  */
 export async function list (context, pattern = '*') {
-  return (await OXSharedAccountService).listAsync({
+  return (await getClient()).listAsync({
     ctx: { id: context.id },
     search_pattern: pattern,
     auth: context.admin
@@ -87,7 +91,7 @@ export async function list (context, pattern = '*') {
  * @returns {Promise<Object>} The shared account object
  */
 export async function getData (context, sharedAccountData) {
-  return (await OXSharedAccountService).getDataAsync({
+  return (await getClient()).getDataAsync({
     ctx: { id: context.id },
     sharedAccount: { id: sharedAccountData.id },
     auth: context.admin
@@ -102,7 +106,7 @@ export async function getData (context, sharedAccountData) {
  * @returns {Promise<void>}
  */
 export async function remove (context, sharedAccountData) {
-  return (await OXSharedAccountService).deleteAsync({
+  return (await getClient()).deleteAsync({
     ctx: { id: context.id },
     sharedAccount: { id: sharedAccountData.id },
     auth: context.admin

package/soap.js

@@ -20,13 +20,14 @@
 
 import { performance, PerformanceObserver } from 'node:perf_hooks'
 import * as SOAP from 'soap'
-import dotenv from 'dotenv'
 import pRetry, { AbortError as RetryAbortError } from 'p-retry'
 
 // Set AbortError correctly
 const AbortError = RetryAbortError
 
-dotenv.config({ path: ['.env', '.env.defaults'], quiet: true })
+for (const envFile of ['.env', '.env.defaults']) {
+  try { process.loadEnvFile(envFile) } catch {}
+}
 
 // This flag enables debug output including timing information.
 const debug = process.env.DEBUG_SOAP === 'true'

package/.env.default

@@ -1,18 +0,0 @@
-# URL to the App Suite Middleware for e2e-provisioning via SOAP
-PROVISIONING_URL=https://appsuite-main.dev.oxui.de/
-
-# URL to the App Suite UI for e2e-tests
-LAUNCH_URL=https://core-ui-main.dev.oxui.de
-
-# admin credentials for e2e middleware
-E2E_ADMIN_USER=
-E2E_ADMIN_PW=
-
-# Flag to enable/disable debug output for SOAP requests
-DEBUG_SOAP=false
-
-MX_DOMAIN=box.ox.io
-
-PROVSIONING_API=common
-
-DOTENV_CONFIG_QUIET=true

package/example-provisioning.json

@@ -1,55 +0,0 @@
-{
-  "contexts": [
-    {
-      "data": {
-        "name": "test",
-        "capabilities": "switchboard,ai-service,spreadsheet,text,document_preview,presentation,presenter,remote_presenter",
-        "config": {
-          "entries": [{
-            "key": "config",
-            "value": {
-              "entries": [
-                { "key": "io.ox/core//ai/openai/useAzure", "value": "false" }
-              ]
-            }
-          }]
-        }
-      },
-      "users": [
-        {
-          "name": "testuser",
-          "primaryEmail": "testuser-123@box.ox.io",
-          "display_name": "Test User",
-          "imapLogin": "testuser-123",
-          "imapServer": "main-dovecot",
-          "smtpServer": "main-postfix",
-          "email1": "testuser-123@box.ox.io",
-          "password": "secret",
-          "sur_name": "User",
-          "given_name": "Test"
-        },
-        {
-          "name": "testuser124",
-          "primaryEmail": "testuser-124@box.ox.io",
-          "display_name": "Test User",
-          "imapLogin": "testuser-124",
-          "imapServer": "main-dovecot",
-          "smtpServer": "main-postfix",
-          "email1": "testuser-124@box.ox.io",
-          "password": "secret",
-          "sur_name": "User",
-          "given_name": "Test124"
-        }
-      ],
-      "secondaryAccount":
-        {
-          "name": "info123",
-          "login": "info123@box.ox.io",
-          "primaryAddress": "info123@box.ox.io",
-          "mailEndpointSource": "primary",
-          "transportEndpointSource": "primary",
-          "personal": "Info 123"
-        }
-    }
-  ]
-}