@api-client/core 0.18.35 → 0.18.37

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.18.35",
+  "version": "0.18.37",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -92,7 +92,7 @@
     "@pawel-up/csv": "^0.2.0",
     "@pawel-up/data-mock": "^0.4.0",
     "@pawel-up/jexl": "^4.0.1",
-    "@types/sinon": "^20.0.0",
+    "@types/sinon": "^21.0.0",
     "@xmldom/xmldom": "^0.8.11",
     "amf-json-ld-lib": "^0.0.15",
     "chalk": "^5.4.1",
@@ -116,6 +116,7 @@
     "@japa/runner": "^4.2.0",
     "@pawel-up/semver": "^0.1.4",
     "@rollup/plugin-typescript": "^12.1.2",
+    "@types/chai-as-promised": "^8.0.2",
     "@types/cors": "^2.8.12",
     "@types/express-ntlm": "^2.3.3",
     "@types/jsdom": "^27.0.0",
@@ -128,6 +129,7 @@
     "@web/test-runner-playwright": "^0.11.0",
     "amf-client-js": "^5.9.1-3",
     "c8": "^10.1.3",
+    "chai-as-promised": "^8.0.2",
     "conventional-changelog-cli": "^5.0.0",
     "cors": "^2.8.5",
     "eslint": "^9.20.1",

package/src/sdk/SdkMock.ts

@@ -2,8 +2,8 @@ import { nanoid } from '../nanoid.js'
 import type { IOrganization } from '../models/store/Organization.js'
 import type { GroupSchema } from '../models/store/Group.js'
 import type { IUser } from '../models/store/User.js'
-import { OrganizationKind } from '../models/kinds.js'
-import { GroupKind } from '../models/kinds.js'
+import type { InvitationSchema } from '../models/store/Invitation.js'
+import { OrganizationKind, GroupKind, InvitationKind } from '../models/kinds.js'
 import { Kind as UserKind } from '../models/store/User.js'
 import { File, type IFile, type FileBreadcrumb } from '../models/store/File.js'
 import { CertificateFileKind, DomainFileKind, FolderKind, ProjectKind } from '../models/kinds.js'
@@ -115,34 +115,133 @@ export class SdkMock {
       })
     },
 
-    /**
-     * Mocks the `organizations.read()` method.
-     * @param options Optional response customization.
-     * @returns A stub reference that can be used to restore the original behavior.
-     */
-    read: (options?: MockResponseOptions): StubReference => {
-      return this.createStub('organizations', 'read', () => {
-        const defaultData = this.generateOrganization()
-        if (options?.status !== undefined && options.status !== 200) {
-          throw new Exception('Mocked error', { status: options.status })
-        }
-        return (options?.data ?? defaultData) as unknown
-      })
+    invitations: {
+      list: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'list', () => {
+          const defaultData = {
+            items: [this.generateInvitation(), this.generateInvitation()],
+          }
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      create: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'create', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      findByToken: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'findByToken', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      decline: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'decline', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      delete: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'delete', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      patch: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'patch', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      resend: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.invitations', 'resend', () => {
+          const defaultData = this.generateInvitation()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
     },
 
-    /**
-     * Mocks the `organizations.delete()` method.
-     * @param options Optional response customization.
-     * @returns A stub reference that can be used to restore the original behavior.
-     */
-    delete: (options?: MockResponseOptions): StubReference => {
-      return this.createStub('organizations', 'delete', () => {
-        const status = options?.status ?? 204
-        if (status !== 204) {
-          throw new Exception('Mocked error', { status })
-        }
-        return undefined
-      })
+    users: {
+      list: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'list', () => {
+          const defaultData = {
+            items: [this.generateUser(), this.generateUser()],
+          }
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      read: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'read', () => {
+          const defaultData = this.generateUser()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      readBatch: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'readBatch', () => {
+          const defaultData = {
+            items: [this.generateUser(), this.generateUser()],
+          }
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      activate: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'activate', () => {
+          const defaultData = this.generateUser()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      deactivate: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'deactivate', () => {
+          const defaultData = this.generateUser()
+          if (options?.status !== undefined && options.status !== 200) {
+            throw new Exception('Mocked error', { status: options.status })
+          }
+          return (options?.data ?? defaultData) as unknown
+        })
+      },
+      delete: (options?: MockResponseOptions): StubReference => {
+        return this.createStub('organizations.users', 'delete', () => {
+          const status = options?.status ?? 204
+          if (status !== 204) {
+            throw new Exception('Mocked error', { status })
+          }
+          return undefined
+        })
+      },
     },
   }
 
@@ -228,6 +327,32 @@ export class SdkMock {
         return undefined
       })
     },
+
+    /**
+     * Mocks the `groups.addUsers()` method.
+     */
+    addUsers: (options?: MockResponseOptions): StubReference => {
+      return this.createStub('groups', 'addUsers', () => {
+        const defaultData = this.generateGroup()
+        if (options?.status !== undefined && options.status !== 200) {
+          throw new Exception('Mocked error', { status: options.status })
+        }
+        return (options?.data ?? defaultData) as unknown
+      })
+    },
+
+    /**
+     * Mocks the `groups.removeUsers()` method.
+     */
+    removeUsers: (options?: MockResponseOptions): StubReference => {
+      return this.createStub('groups', 'removeUsers', () => {
+        const defaultData = this.generateGroup()
+        if (options?.status !== undefined && options.status !== 200) {
+          throw new Exception('Mocked error', { status: options.status })
+        }
+        return (options?.data ?? defaultData) as unknown
+      })
+    },
   }
 
   /**
@@ -243,7 +368,7 @@ export class SdkMock {
       return this.createStub('user', 'me', () => {
         const defaultData = this.generateUser()
         if (options?.status !== undefined && options.status !== 200) {
-          throw new Exception('Mocked error', { status: options.status })
+          throw new Exception(`Mocked error. Status: ${options.status}`, { status: options.status })
         }
         return (options?.data ?? defaultData) as unknown
       })
@@ -587,15 +712,28 @@ export class SdkMock {
    * @returns A stub reference.
    */
   private createStub(
-    api: 'organizations' | 'groups' | 'user' | 'auth' | 'file' | 'shared' | 'trash',
+    api:
+      | 'organizations'
+      | 'groups'
+      | 'user'
+      | 'auth'
+      | 'file'
+      | 'shared'
+      | 'trash'
+      | 'organizations.invitations'
+      | 'organizations.users',
     method: string,
     implementation: () => unknown,
     sync?: boolean
   ): StubReference {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const target = (this.sdk as any)[api]
-    if (!target) {
-      throw new Error(`API '${api}' not found in SDK`)
+    let target: any = this.sdk
+    const parts = api.split('.')
+    for (const part of parts) {
+      target = target[part]
+      if (!target) {
+        throw new Error(`API '${api}' not found in SDK`)
+      }
     }
 
     const original = target[method]
@@ -736,6 +874,31 @@ export class SdkMock {
     return items
   }
 
+  /**
+   * Generates a random invitation object.
+   */
+  private generateInvitation(): InvitationSchema {
+    const firstName = this.randomString()
+    const lastName = this.randomString()
+    const now = Date.now()
+    return {
+      kind: InvitationKind,
+      key: nanoid(),
+      uid: nanoid(),
+      oid: nanoid(),
+      email: `${firstName.toLowerCase()}.${lastName.toLowerCase()}@example.com`,
+      name: `${firstName} ${lastName}`,
+      token: nanoid(),
+      expiresAt: now + 7 * 24 * 60 * 60 * 1000,
+      status: 'pending',
+      grantType: this.randomChoice(['owner', 'manager', 'editor', 'viewer'] as const),
+      createdAt: now - Math.random() * 1000 * 60 * 60 * 24,
+      updatedAt: now - Math.random() * 1000 * 60 * 60,
+      resent: 0,
+      lastSentAt: now - Math.random() * 1000 * 60 * 60,
+    }
+  }
+
   /**
    * Generates a random trash entry.
    */