Merge pull request #169 from flowcore-io/add-tenant-preview-command

feat: add tenant preview command and schema for public tenant previews

Author: odinellefsen

src/commands/index.ts

@@ -9,6 +9,7 @@ export * from "./tenant/tenant.user-add.ts"
 export * from "./tenant/tenant.user-remove.ts"
 export * from "./tenant/tenant.user-list.ts"
 export * from "./tenant/tenant.translate-name-to-id.ts"
+export * from "./tenant/tenant.preview.ts"
 
 // Adapter
 export * from "./adapter/reset-adapter.ts"

src/commands/tenant/tenant.preview.ts

@@ -0,0 +1,57 @@
+import { Command } from "../../common/command.ts"
+import type { TenantPreview } from "../../contracts/tenant.ts"
+import { TenantPreviewSchema } from "../../contracts/tenant.ts"
+import type { ClientError } from "../../exceptions/client-error.ts"
+import { NotFoundException } from "../../exceptions/not-found.ts"
+import { parseResponseHelper } from "../../utils/parse-response-helper.ts"
+
+/**
+ * The input for the tenant preview command
+ */
+export interface TenantPreviewInput {
+  /** The name of the tenant to preview */
+  name: string
+}
+
+/**
+ * Retrieve a public tenant preview
+ */
+export class TenantPreviewCommand extends Command<TenantPreviewInput, TenantPreview> {
+  /**
+   * Get the method
+   */
+  protected override getMethod(): string {
+    return "GET"
+  }
+
+  /**
+   * Get the base url
+   */
+  protected override getBaseUrl(): string {
+    return "https://tenant.api.flowcore.io"
+  }
+
+  /**
+   * Get the path
+   */
+  protected override getPath(): string {
+    return `/api/v1/tenants/preview/${this.input.name}`
+  }
+
+  /**
+   * Parse the response
+   */
+  protected override parseResponse(rawResponse: unknown): TenantPreview {
+    return parseResponseHelper(TenantPreviewSchema, rawResponse)
+  }
+
+  /**
+   * Handle the client error
+   */
+  protected override handleClientError(error: ClientError): void {
+    if (error.status === 404) {
+      throw new NotFoundException("Tenant", { name: this.input.name })
+    }
+    throw error
+  }
+}

src/contracts/index.ts

@@ -13,7 +13,7 @@ export type {
 } from "./event-type.ts"
 export type { FlowType } from "./flow-type.ts"
 export type { FlowcoreEvent, IngestEventInput } from "./event.ts"
-export type { Tenant } from "./tenant.ts"
+export type { Tenant, TenantPreview } from "./tenant.ts"
 export type { Permission } from "./permission.ts"
 export type {
   LegacyScenario,

src/contracts/tenant.ts

@@ -130,3 +130,17 @@ export const TenantUserSchema: TObject<{
  * The type for a tenant user
  */
 export type TenantUser = Static<typeof TenantUserSchema>
+
+/**
+ * The schema for a public tenant preview
+ */
+export const TenantPreviewSchema: TObject = Type.Object({
+  displayName: Type.String(),
+  websiteUrl: Type.String(),
+  description: Type.String(),
+})
+
+/**
+ * The type for a public tenant preview
+ */
+export type TenantPreview = Static<typeof TenantPreviewSchema>

test/tests/commands/tenant.test.ts

@@ -1,6 +1,13 @@
-import { assertEquals } from "@std/assert"
+import { assertEquals, assertRejects } from "@std/assert"
 import { afterAll, afterEach, describe, it } from "@std/testing/bdd"
-import { FlowcoreClient, type Tenant, TenantTranslateNameToIdCommand } from "../../../src/mod.ts"
+import {
+  FlowcoreClient,
+  NotFoundException,
+  type Tenant,
+  type TenantPreview,
+  TenantPreviewCommand,
+  TenantTranslateNameToIdCommand,
+} from "../../../src/mod.ts"
 import { FetchMocker } from "../../fixtures/fetch.fixture.ts"
 
 describe("Tenant", () => {
@@ -39,4 +46,33 @@ describe("Tenant", () => {
       name: tenant.name,
     })
   })
+
+  it("should return a tenant preview", async () => {
+    const preview: TenantPreview = {
+      displayName: "Example Tenant",
+      websiteUrl: "https://example.com",
+      description: "An example tenant",
+    }
+
+    fetchMockerBuilder.get(`/api/v1/tenants/preview/example`)
+      .respondWith(200, preview)
+
+    const command = new TenantPreviewCommand({ name: "example" })
+    const response = await flowcoreClient.execute(command)
+
+    assertEquals(response, preview)
+  })
+
+  it("should throw NotFoundException when preview tenant is not found", async () => {
+    fetchMockerBuilder.get(`/api/v1/tenants/preview/missing`)
+      .respondWith(404, { message: "Tenant not found" })
+
+    const command = new TenantPreviewCommand({ name: "missing" })
+
+    await assertRejects(
+      () => flowcoreClient.execute(command),
+      NotFoundException,
+      `Tenant not found: ${JSON.stringify({ name: "missing" })}`,
+    )
+  })
 })