feat(medusa, types, core-flows): Add invite endpoints for api-v2

integration-tests/plugins/__tests__/invites/create-invite.spec.ts

@@ -0,0 +1,55 @@
+import { initDb, useDb } from "../../../environment-helpers/use-db"
+
+import path from "path"
+import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
+import { useApi } from "../../../environment-helpers/use-api"
+import adminSeeder from "../../../helpers/admin-seeder"
+import { AxiosInstance } from "axios"
+
+jest.setTimeout(50000)
+
+const env = { MEDUSA_FF_MEDUSA_V2: true }
+const adminHeaders = {
+  headers: { "x-medusa-access-token": "test_token" },
+}
+
+describe("POST /admin/invites", () => {
+  let dbConnection
+  let shutdownServer
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", ".."))
+    dbConnection = await initDb({ cwd, env } as any)
+    shutdownServer = await startBootstrapApp({ cwd, env })
+  })
+
+  beforeEach(async () => {
+    await adminSeeder(dbConnection)
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+    await shutdownServer()
+  })
+
+  afterEach(async () => {
+    const db = useDb()
+    await db.teardown()
+  })
+
+  it("create an invite", async () => {
+    const api = useApi()! as AxiosInstance
+
+    const body = {
+      email: "test_member@test.com",
+    }
+
+    const response = await api.post(`/admin/invites`, body, adminHeaders)
+
+    expect(response.status).toEqual(200)
+    expect(response.data).toEqual({
+      invite: expect.objectContaining(body),
+    })
+  })
+})

integration-tests/plugins/__tests__/invites/delete-invite.spec.ts

@@ -0,0 +1,76 @@
+import { initDb, useDb } from "../../../environment-helpers/use-db"
+
+import { IUserModuleService } from "@medusajs/types"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { getContainer } from "../../../environment-helpers/use-container"
+import path from "path"
+import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
+import { useApi } from "../../../environment-helpers/use-api"
+import adminSeeder from "../../../helpers/admin-seeder"
+import { AxiosInstance } from "axios"
+
+jest.setTimeout(50000)
+
+const env = { MEDUSA_FF_MEDUSA_V2: true }
+const adminHeaders = {
+  headers: { "x-medusa-access-token": "test_token" },
+}
+
+describe("DELETE /admin/invites/:id", () => {
+  let dbConnection
+  let appContainer
+  let shutdownServer
+  let userModuleService: IUserModuleService
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", ".."))
+    dbConnection = await initDb({ cwd, env } as any)
+    shutdownServer = await startBootstrapApp({ cwd, env })
+    appContainer = getContainer()
+    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+  })
+
+  beforeEach(async () => {
+    await adminSeeder(dbConnection)
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+    await shutdownServer()
+  })
+
+  afterEach(async () => {
+    const db = useDb()
+    await db.teardown()
+  })
+
+  it("should delete a single invite", async () => {
+    const invite = await userModuleService.createInvites({
+      email: "potential_member@test.com",
+      token: "test",
+      expires_at: new Date(),
+    })
+
+    const api = useApi()! as AxiosInstance
+
+    const response = await api.delete(
+      `/admin/invites/${invite.id}`,
+      adminHeaders
+    )
+
+    expect(response.status).toEqual(200)
+    expect(response.data).toEqual({
+      id: invite.id,
+      object: "invite",
+      deleted: true,
+    })
+
+    const { response: deletedResponse } = await api
+      .get(`/admin/invites/${invite.id}`, adminHeaders)
+      .catch((e) => e)
+
+    expect(deletedResponse.status).toEqual(404)
+    expect(deletedResponse.data.type).toEqual("not_found")
+  })
+})

integration-tests/plugins/__tests__/invites/list-invites.spec.ts

@@ -0,0 +1,69 @@
+import { initDb, useDb } from "../../../environment-helpers/use-db"
+
+import { IUserModuleService } from "@medusajs/types"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { getContainer } from "../../../environment-helpers/use-container"
+import path from "path"
+import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
+import { useApi } from "../../../environment-helpers/use-api"
+import adminSeeder from "../../../helpers/admin-seeder"
+import { AxiosInstance } from "axios"
+
+jest.setTimeout(50000)
+
+const env = { MEDUSA_FF_MEDUSA_V2: true }
+const adminHeaders = {
+  headers: { "x-medusa-access-token": "test_token" },
+}
+
+describe("GET /admin/invites", () => {
+  let dbConnection
+  let appContainer
+  let shutdownServer
+  let userModuleService: IUserModuleService
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", ".."))
+    dbConnection = await initDb({ cwd, env } as any)
+    shutdownServer = await startBootstrapApp({ cwd, env })
+    appContainer = getContainer()
+    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+  })
+
+  beforeEach(async () => {
+    await adminSeeder(dbConnection)
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+    await shutdownServer()
+  })
+
+  afterEach(async () => {
+    const db = useDb()
+    await db.teardown()
+  })
+
+  it("should list invites", async () => {
+    await userModuleService.createInvites({
+      email: "potential_member@test.com",
+      token: "test",
+      expires_at: new Date(),
+    })
+
+    const api = useApi()! as AxiosInstance
+
+    const response = await api.get(`/admin/invites`, adminHeaders)
+
+    expect(response.status).toEqual(200)
+    expect(response.data).toEqual({
+      invites: [
+        expect.objectContaining({ email: "potential_member@test.com" }),
+      ],
+      count: 1,
+      offset: 0,
+      limit: 50,
+    })
+  })
+})

integration-tests/plugins/__tests__/invites/retrieve-invite.spec.ts

@@ -0,0 +1,64 @@
+import { initDb, useDb } from "../../../environment-helpers/use-db"
+
+import { IUserModuleService } from "@medusajs/types"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { getContainer } from "../../../environment-helpers/use-container"
+import path from "path"
+import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
+import { useApi } from "../../../environment-helpers/use-api"
+import adminSeeder from "../../../helpers/admin-seeder"
+import { AxiosInstance } from "axios"
+
+jest.setTimeout(50000)
+
+const env = { MEDUSA_FF_MEDUSA_V2: true }
+const adminHeaders = {
+  headers: { "x-medusa-access-token": "test_token" },
+}
+
+describe("GET /admin/invites/:id", () => {
+  let dbConnection
+  let appContainer
+  let shutdownServer
+  let userModuleService: IUserModuleService
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", ".."))
+    dbConnection = await initDb({ cwd, env } as any)
+    shutdownServer = await startBootstrapApp({ cwd, env })
+    appContainer = getContainer()
+    userModuleService = appContainer.resolve(ModuleRegistrationName.USER)
+  })
+
+  beforeEach(async () => {
+    await adminSeeder(dbConnection)
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+    await shutdownServer()
+  })
+
+  afterEach(async () => {
+    const db = useDb()
+    await db.teardown()
+  })
+
+  it("should retrieve a single invite", async () => {
+    const invite = await userModuleService.createInvites({
+      email: "potential_member@test.com",
+      token: "test",
+      expires_at: new Date(),
+    })
+
+    const api = useApi()! as AxiosInstance
+
+    const response = await api.get(`/admin/invites/${invite.id}`, adminHeaders)
+
+    expect(response.status).toEqual(200)
+    expect(response.data.invite).toEqual(
+      expect.objectContaining({ email: "potential_member@test.com" })
+    )
+  })
+})

packages/core-flows/src/index.ts

@@ -5,3 +5,4 @@ export * from "./promotion"
 export * from "./customer"
 export * from "./customer-group"
 export * from "./user"
+export * from "./invite"

packages/core-flows/src/invite/index.ts

@@ -0,0 +1,2 @@
+export * from "./steps"
+export * from "./workflows"

packages/core-flows/src/invite/steps/create-invites.ts

@@ -0,0 +1,31 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { CreateInviteDTO, IUserModuleService, InviteDTO } from "@medusajs/types"
+import { StepResponse, createStep } from "@medusajs/workflows-sdk"
+
+export const createInviteStepId = "create-invite-step"
+export const createInviteStep = createStep(
+  createInviteStepId,
+  async (input: CreateInviteDTO[], { container }) => {
+    const service: IUserModuleService = container.resolve(
+      ModuleRegistrationName.USER
+    )
+
+    const createdInvites = await service.createInvites(input)
+
+    return new StepResponse(
+      createdInvites,
+      createdInvites.map((inv) => inv.id)
+    )
+  },
+  async (createdInvitesIds, { container }) => {
+    if (!createdInvitesIds?.length) {
+      return
+    }
+
+    const service: IUserModuleService = container.resolve(
+      ModuleRegistrationName.USER
+    )
+
+    await service.deleteInvites(createdInvitesIds)
+  }
+)

packages/core-flows/src/invite/steps/delete-invites.ts

@@ -0,0 +1,28 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IUserModuleService } from "@medusajs/types"
+import { StepResponse, createStep } from "@medusajs/workflows-sdk"
+
+export const deleteInvitesStepId = "delete-invites-step"
+export const deleteInvitesStep = createStep(
+  deleteInvitesStepId,
+  async (input: string[], { container }) => {
+    const service: IUserModuleService = container.resolve(
+      ModuleRegistrationName.USER
+    )
+
+    await service.softDeleteInvites(input)
+
+    return new StepResponse(void 0, input)
+  },
+  async (deletedInviteIds, { container }) => {
+    if (!deletedInviteIds?.length) {
+      return
+    }
+
+    const service: IUserModuleService = container.resolve(
+      ModuleRegistrationName.USER
+    )
+
+    await service.restoreInvites(deletedInviteIds)
+  }
+)

packages/core-flows/src/invite/steps/index.ts

@@ -0,0 +1,2 @@
+export * from "./create-invites"
+export * from "./delete-invites"

packages/core-flows/src/invite/workflows/create-invites.ts

@@ -0,0 +1,13 @@
+import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
+import { createInviteStep } from "../steps"
+import { InviteDTO, InviteWorkflow } from "@medusajs/types"
+
+export const createInvitesWorkflowId = "create-invite-step"
+export const createInvitesWorkflow = createWorkflow(
+  createInvitesWorkflowId,
+  (
+    input: WorkflowData<InviteWorkflow.CreateInvitesWorkflowInputDTO>
+  ): WorkflowData<InviteDTO[]> => {
+    return createInviteStep(input.invites)
+  }
+)

packages/core-flows/src/invite/workflows/delete-invites.ts

@@ -0,0 +1,13 @@
+import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
+import { deleteInvitesStep } from "../steps"
+import { InviteWorkflow, UserWorkflow } from "@medusajs/types"
+
+export const deleteInvitesWorkflowId = "delete-invites-workflow"
+export const deleteInvitesWorkflow = createWorkflow(
+  deleteInvitesWorkflowId,
+  (
+    input: WorkflowData<InviteWorkflow.DeleteInvitesWorkflowInput>
+  ): WorkflowData<void> => {
+    return deleteInvitesStep(input.ids)
+  }
+)

packages/core-flows/src/invite/workflows/index.ts

@@ -0,0 +1,2 @@
+export * from "./create-invites"
+export * from "./delete-invites"