feat: add UserInviteToTenantCommand for inviting users to a tenant

Author: odinellefsen

src/commands/index.ts

@@ -87,6 +87,7 @@ export * from "./security/permissions.list.ts"
 
 // User
 export * from "./user/user.initialize-in-keycloak.ts"
+export * from "./user/user.invite-to-tenant.ts"
 
 // Scenario
 export * from "./scenario/scenario.create.ts"

src/commands/user/user.invite-to-tenant.ts

@@ -0,0 +1,69 @@
+import { Type } from "@sinclair/typebox"
+import { Command } from "../../common/command.ts"
+import { parseResponseHelper } from "../../utils/parse-response-helper.ts"
+import type { Static, TBoolean, TObject, TString } from "@sinclair/typebox"
+
+/**
+ * The input for inviting a user to a tenant
+ */
+export interface UserInviteToTenantInput {
+  tenantName: string
+  userEmail: string
+}
+
+/**
+ * The output for inviting a user to a tenant
+ */
+export type UserInviteToTenantOutput = Static<typeof responseSchema>
+
+const responseSchema: TObject<{
+  success: TBoolean
+  tenantName: TString
+  invitedEmail: TString
+}> = Type.Object({
+  success: Type.Boolean(),
+  tenantName: Type.String(),
+  invitedEmail: Type.String(),
+})
+
+/**
+ * Invite an existing user (by email) to a tenant
+ */
+export class UserInviteToTenantCommand extends Command<
+  UserInviteToTenantInput,
+  UserInviteToTenantOutput
+> {
+  /**
+   * The allowed modes for the command
+   */
+  protected override allowedModes: ("apiKey" | "bearer")[] = ["bearer"]
+
+  /**
+   * Get the base URL for the request
+   */
+  protected override getBaseUrl(): string {
+    return "https://user-2.api.flowcore.io"
+  }
+
+  /**
+   * Get the method
+   */
+  protected override getMethod(): string {
+    return "POST"
+  }
+
+  /**
+   * Get the path for the request
+   */
+  protected override getPath(): string {
+    return "/api/users/invitations"
+  }
+
+  /**
+   * Parse the response
+   */
+  protected override parseResponse(rawResponse: unknown): UserInviteToTenantOutput {
+    const response = parseResponseHelper(responseSchema, rawResponse)
+    return response
+  }
+}

test/tests/commands/user.test.ts

@@ -1,6 +1,10 @@
 import { assertEquals } from "@std/assert"
 import { afterAll, afterEach, describe, it } from "@std/testing/bdd"
-import { FlowcoreClient, UserInitializeInKeycloakCommand } from "../../../src/mod.ts"
+import {
+  FlowcoreClient,
+  UserInitializeInKeycloakCommand,
+  UserInviteToTenantCommand,
+} from "../../../src/mod.ts"
 import { FetchMocker } from "../../fixtures/fetch.fixture.ts"
 
 describe("User", () => {
@@ -68,4 +72,34 @@ describe("User", () => {
       assertEquals(response, userData)
     })
   })
+
+  describe("UserInviteToTenantCommand", () => {
+    it("should POST /api/users/invitations and return invitation response", async () => {
+      // arrange
+      const requestBody = {
+        tenantName: "example-tenant",
+        userEmail: "user@example.com",
+      }
+      const responseData = {
+        success: true,
+        tenantName: requestBody.tenantName,
+        invitedEmail: requestBody.userEmail,
+      }
+
+      fetchMockerBuilder.post("/api/users/invitations")
+        .matchHeaders({
+          Authorization: "Bearer BEARER_TOKEN",
+          "Content-Type": "application/json",
+        })
+        .matchBody(requestBody)
+        .respondWith(200, responseData)
+
+      // act
+      const command = new UserInviteToTenantCommand(requestBody)
+      const response = await flowcoreClient.execute(command)
+
+      // assert
+      assertEquals(response, responseData)
+    })
+  })
 })