@open-xchange/soap-client 0.0.1 → 0.0.2

package/.env.default

@@ -14,3 +14,5 @@ DEBUG_SOAP=false
 MX_DOMAIN=box.ox.io
 
 PROVSIONING_API=common
+
+DOTENV_CONFIG_QUIET=true

package/README.md

@@ -0,0 +1,115 @@
+# @open-xchange/soap-client
+
+This project provides an API facade for the OX App Suite Middleware SOAP API, making it easy to interact with provisioning endpoints such as contexts, users, secondary accounts, and more.
+
+## Features
+
+- **API Facade:** Programmatically access and manage OX App Suite resources via a simple JavaScript API.
+- **Provisioning Script:** Easily create, update, and delete contexts, users, and secondary accounts from the command line.
+- **Configurable:** Uses `.env` files for environment-specific configuration.
+
+## Usage
+
+### CLI Provisioning
+
+You can use the built-in provisioning script to automate resource creation. Simply run:
+
+```sh
+npx @open-xchange/soap-client
+```
+If you already have installed the package in your project, you can run the script directly:
+
+```sh
+pnpm provision.js
+```
+
+This will execute the provisioning tool, which reads configuration from a JSON file (default: `./provisioning.json`). You can specify a different file with the `-f` option:
+
+```sh
+npx @open-xchange/soap-client -f example-provisioning.json
+```
+The JSON file should contain the resources to provision. For example:
+
+```json
+{
+  "contexts": [
+    {
+      "data": {
+        "name": "test",
+        "capabilities": "foo,bar",
+        "config": {
+          "entries": [{
+            "key": "config",
+            "value": {
+              "entries": [
+                { "key": "io.ox/core//foobar", "value": "false" }
+              ]
+            }
+          }]
+        }
+      },
+      "users": [
+        {
+          "name": "testuser",
+          "primaryEmail": "testuser-123@example.com",
+          "display_name": "Test User",
+          "imapLogin": "testuser-123",
+          "imapServer": "main-dovecot",
+          "smtpServer": "main-postfix",
+          "email1": "testuser-123@box.ox.io",
+          "password": "supersecret",
+          "sur_name": "User",
+          "given_name": "Test"
+        }
+      ],
+      "secondaryAccount":
+        {
+          "name": "info",
+          "login": "info@example.com",
+          "primaryAddress": "info@example.com",
+          "mailEndpointSource": "primary",
+          "transportEndpointSource": "primary",
+          "personal": "Info"
+        }
+    }
+  ]
+}
+```
+
+### Example: Creating Resources
+
+The CLI supports creating contexts, users, and secondary accounts:
+
+```sh
+npx @open-xchange/soap-client create context --name my-context
+npx @open-xchange/soap-client create user --context-id 123 --email user@example.com --name myuser
+npx @open-xchange/soap-client create account --context-id 123 --name info --email info@example.com --users 1,2,3
+```
+
+### Example: Deleting Resources
+
+```sh
+npx @open-xchange/soap-client delete context --id 123
+npx @open-xchange/soap-client delete user --context-id 123 --id 456
+npx @open-xchange/soap-client delete account --context-id 123 --email info@example.com --users 1,2,3
+```
+
+## API Usage
+
+You can also use the API programmatically in your Node.js projects and choose between either the common or the reseller API when doing so by importing the respective service:
+
+
+```js
+import { contextService, userService } from '@open-xchange/soap-client/common'
+
+const context = await contextService.create({ name: 'my-context' })
+const user = await userService.create(context, { name: 'myuser', email1: 'user@example.com' })
+```
+
+## Configuration
+
+Set up your `.env` file with the required environment variables. See `.env.default` for an example.
+
+---
+
+For more details, see the [bin/provision.js](bin/provision.js) script and the [services](services/) directory.

package/bin/provision.js

@@ -33,7 +33,10 @@ function checkEnvironmentVariables () {
 }
 
 async function getOrCreateContext (data) {
-  const contextData = { ...{ maxQuota: -1 }, ...data }
+  const contextData = {
+    ...{ maxQuota: -1 },
+    ...data
+  }
   let context
   try {
     const existingContext = await contextService.list(contextData.id || contextData.name)
@@ -47,7 +50,7 @@ async function getOrCreateContext (data) {
     }
     return {
       ...context,
-      ...contextAdmin
+      admin: data.admin || contextAdmin.admin
     }
   } catch (error) {
     console.error('Error in context operation:', error)
@@ -72,13 +75,14 @@ async function getOrCreateUser (context, userData) {
 
 async function getOrCreateSecondaryAccount (accountData, context, users) {
   try {
-    const existingAccounts = (await secondaryAccountService.list(context, users)).filter(acc => acc.name === accountData.name)
+    const existingAccounts = (await secondaryAccountService.list(context, users))
     if (existingAccounts?.length > 0) {
+      const filteredAccounts = existingAccounts.filter(acc => acc.primaryAddress === accountData.primaryAddress)
       const usersWithoutAccount = users.filter(user => {
-        const hasAccount = existingAccounts.some(acc => acc.userId === user.id)
+        const hasAccount = filteredAccounts.some(acc => acc.userId === user.id)
         return !hasAccount
       })
-      if (usersWithoutAccount.length === 0) return existingAccounts[0]
+      if (usersWithoutAccount.length === 0) return filteredAccounts[0]
       return await secondaryAccountService.create(accountData, context, usersWithoutAccount)
     }
     console.log('Creating new secondary account')
@@ -104,8 +108,7 @@ async function provisionFromFile (configPath) {
   for (const contexts of config.contexts || []) {
     try {
       const contextData = contexts.data
-      const context = await getOrCreateContext(contexts.data.name)
-
+      const context = await getOrCreateContext({ name: contexts.data.name, admin: contexts.data.admin })
       if (contextData.capabilities) {
         try {
           await contextService.changeCapabilities(context.id, contextData.capabilities, undefined)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",
@@ -20,10 +20,10 @@
   "author": "",
   "license": "AGPL-3.0-or-later",
   "dependencies": {
-    "commander": "^13.1.0",
-    "dotenv": "^16.4.5",
+    "commander": "^14.0.0",
+    "dotenv": "^17.2.0",
     "p-retry": "^6.2.1",
-    "soap": "^1.1.10"
+    "soap": "^1.1.12"
   },
   "devDependencies": {
     "@open-xchange/lint": "0.2.0"

package/soap.js

@@ -26,8 +26,7 @@ import pRetry, { AbortError as RetryAbortError } from 'p-retry'
 // Set AbortError correctly
 const AbortError = RetryAbortError
 
-dotenv.config({ path: '.env' })
-dotenv.config({ path: '.env.defaults' })
+dotenv.config({ path: ['.env', '.env.defaults'], quiet: true })
 
 // This flag enables debug output including timing information.
 const debug = process.env.DEBUG_SOAP === 'true'