feat(api-key): Add the endpoints and workflows for api key module

packages/medusa/src/api-v2/admin/api-keys/[id]/revoke/route.ts

@@ -0,0 +1,23 @@
+import { revokeApiKeysWorkflow } from "@medusajs/core-flows"
+import { RevokeApiKeyDTO } from "@medusajs/types"
+import { MedusaRequest, MedusaResponse } from "../../../../../types/routing"
+
+export const POST = async (req: MedusaRequest, res: MedusaResponse) => {
+  const id = req.params.id
+
+  const { result, errors } = await revokeApiKeysWorkflow(req.scope).run({
+    input: {
+      selector: { id: req.params.id },
+      revoke: {
+        revoked_by: req.auth_user?.id,
+      } as RevokeApiKeyDTO,
+    },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({ apiKey: result[0] })
+}

packages/medusa/src/api-v2/admin/api-keys/[id]/route.ts

@@ -0,0 +1,59 @@
+import {
+  deleteApiKeysWorkflow,
+  updateApiKeysWorkflow,
+} from "@medusajs/core-flows"
+import { UpdateApiKeyDTO } from "@medusajs/types"
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
+import { defaultAdminApiKeyFields } from "../query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const variables = { id: req.params.id }
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "api-key",
+    variables,
+    fields: defaultAdminApiKeyFields,
+  })
+
+  const [apiKey] = await remoteQuery(queryObject)
+
+  res.status(200).json({ apiKey })
+}
+
+export const POST = async (req: MedusaRequest, res: MedusaResponse) => {
+  const { result, errors } = await updateApiKeysWorkflow(req.scope).run({
+    input: {
+      selector: { id: req.params.id },
+      update: req.validatedBody as Omit<UpdateApiKeyDTO, "id">,
+    },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({ apiKey: result[0] })
+}
+
+export const DELETE = async (req: MedusaRequest, res: MedusaResponse) => {
+  const id = req.params.id
+
+  const { errors } = await deleteApiKeysWorkflow(req.scope).run({
+    input: { ids: [id] },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({
+    id,
+    object: "api-key",
+    deleted: true,
+  })
+}

packages/medusa/src/api-v2/admin/api-keys/middlewares.ts

@@ -0,0 +1,64 @@
+import { transformBody, transformQuery } from "../../../api/middlewares"
+import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import * as QueryConfig from "./query-config"
+import {
+  AdminGetApiKeysParams,
+  AdminGetApiKeysApiKeyParams,
+  AdminPostApiKeysReq,
+  AdminPostApiKeysApiKeyReq,
+  AdminRevokeApiKeysApiKeyReq,
+} from "./validators"
+
+export const adminApiKeyRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    matcher: "/admin/api-keys*",
+    // middlewares: [authenticate("admin", ["bearer", "session"])],
+    // TODO: Apply authentication middleware correctly once https://github.com/medusajs/medusa/pull/6447 is merged.
+    middlewares: [
+      (req, res, next) => {
+        req.auth_user = { id: "test" }
+        next()
+      },
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/api-keys",
+    middlewares: [
+      transformQuery(
+        AdminGetApiKeysParams,
+        QueryConfig.listTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/api-keys/:id",
+    middlewares: [
+      transformQuery(
+        AdminGetApiKeysApiKeyParams,
+        QueryConfig.retrieveTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["POST"],
+    matcher: "/admin/api-keys",
+    middlewares: [transformBody(AdminPostApiKeysReq)],
+  },
+  {
+    method: ["POST"],
+    matcher: "/admin/api-keys/:id",
+    middlewares: [transformBody(AdminPostApiKeysApiKeyReq)],
+  },
+  {
+    method: ["DELETE"],
+    matcher: "/admin/api-keys/:id",
+    middlewares: [],
+  },
+  {
+    method: ["POST"],
+    matcher: "/admin/api-keys/:id/revoke",
+    middlewares: [transformBody(AdminRevokeApiKeysApiKeyReq)],
+  },
+]

packages/medusa/src/api-v2/admin/api-keys/query-config.ts

@@ -0,0 +1,26 @@
+export const defaultAdminApiKeyRelations = []
+export const allowedAdminApiKeyRelations = []
+export const defaultAdminApiKeyFields = [
+  "id",
+  "title",
+  "token",
+  "redacted",
+  "type",
+  "last_used_at",
+  "created_at",
+  "created_by",
+  "revoked_at",
+  "revoked_by",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultAdminApiKeyFields,
+  defaultRelations: defaultAdminApiKeyRelations,
+  allowedRelations: allowedAdminApiKeyRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  defaultLimit: 20,
+  isList: true,
+}

packages/medusa/src/api-v2/admin/api-keys/route.ts

@@ -0,0 +1,49 @@
+import { createApiKeysWorkflow } from "@medusajs/core-flows"
+import { CreateApiKeyDTO } from "@medusajs/types"
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../types/routing"
+import { defaultAdminApiKeyFields } from "./query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "api-key",
+    variables: {
+      filters: req.filterableFields,
+      order: req.listConfig.order,
+      skip: req.listConfig.skip,
+      take: req.listConfig.take,
+    },
+    fields: defaultAdminApiKeyFields,
+  })
+
+  const { rows: apiKeys, metadata } = await remoteQuery(queryObject)
+
+  res.json({
+    apiKeys,
+    count: metadata.count,
+    offset: metadata.skip,
+    limit: metadata.take,
+  })
+}
+
+export const POST = async (req: MedusaRequest, res: MedusaResponse) => {
+  const input = [
+    {
+      ...(req.validatedBody as Omit<CreateApiKeyDTO, "created_by">),
+      created_by: req.auth_user?.id,
+    } as CreateApiKeyDTO,
+  ]
+
+  const { result, errors } = await createApiKeysWorkflow(req.scope).run({
+    input: { apiKeysData: input },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({ apiKey: result[0] })
+}

packages/medusa/src/api-v2/admin/api-keys/validators.ts

@@ -0,0 +1,70 @@
+import { OperatorMap } from "@medusajs/types"
+import { Type } from "class-transformer"
+import {
+  IsArray,
+  IsEnum,
+  IsOptional,
+  IsString,
+  ValidateNested,
+} from "class-validator"
+import { FindParams, extendedFindParamsMixin } from "../../../types/common"
+import { OperatorMapValidator } from "../../../types/validators/operator-map"
+import { ApiKeyType } from "@medusajs/utils"
+
+export class AdminGetApiKeysApiKeyParams extends FindParams {}
+/**
+ * Parameters used to filter and configure the pagination of the retrieved api keys.
+ */
+export class AdminGetApiKeysParams extends extendedFindParamsMixin({
+  limit: 50,
+  offset: 0,
+}) {
+  /**
+   * Search parameter for api keys.
+   */
+  @IsString({ each: true })
+  @IsOptional()
+  id?: string | string[]
+
+  /**
+   * Filter by title
+   */
+  @IsString({ each: true })
+  @IsOptional()
+  title?: string | string[]
+
+  /**
+   * Filter by type
+   */
+  @IsEnum(ApiKeyType, { each: true })
+  @IsOptional()
+  type?: ApiKeyType
+
+  // Additional filters from BaseFilterable
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetApiKeysParams)
+  $and?: AdminGetApiKeysParams[]
+
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetApiKeysParams)
+  $or?: AdminGetApiKeysParams[]
+}
+
+export class AdminPostApiKeysReq {
+  @IsString()
+  title: string
+
+  @IsEnum(ApiKeyType, {})
+  type: ApiKeyType
+}
+
+export class AdminPostApiKeysApiKeyReq {
+  @IsString()
+  title: string
+}
+
+export class AdminRevokeApiKeysApiKeyReq {}
+
+export class AdminDeleteApiKeysApiKeyReq {}