feat: Add basic endpoints and workflows for Store module (#6515)

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

@@ -0,0 +1,36 @@
+import { updateStoresWorkflow } from "@medusajs/core-flows"
+import { UpdateStoreDTO } from "@medusajs/types"
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
+import { defaultAdminStoreFields } 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: "store",
+    variables,
+    fields: defaultAdminStoreFields,
+  })
+
+  const [store] = await remoteQuery(queryObject)
+  res.status(200).json({ store })
+}
+
+export const POST = async (req: MedusaRequest, res: MedusaResponse) => {
+  const { result, errors } = await updateStoresWorkflow(req.scope).run({
+    input: {
+      selector: { id: req.params.id },
+      update: req.validatedBody as UpdateStoreDTO,
+    },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({ store: result[0] })
+}

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

@@ -0,0 +1,42 @@
+import { transformBody, transformQuery } from "../../../api/middlewares"
+import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import { authenticate } from "../../../utils/authenticate-middleware"
+import * as QueryConfig from "./query-config"
+import {
+  AdminGetStoresParams,
+  AdminGetStoresStoreParams,
+  AdminPostStoresStoreReq,
+} from "./validators"
+
+export const adminStoreRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    method: ["ALL"],
+    matcher: "/admin/stores*",
+    middlewares: [authenticate("admin", ["bearer", "session", "api-key"])],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/stores",
+    middlewares: [
+      transformQuery(
+        AdminGetStoresParams,
+        QueryConfig.listTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/stores/:id",
+    middlewares: [
+      transformQuery(
+        AdminGetStoresStoreParams,
+        QueryConfig.retrieveTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["POST"],
+    matcher: "/admin/stores/:id",
+    middlewares: [transformBody(AdminPostStoresStoreReq)],
+  },
+]

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

@@ -0,0 +1,22 @@
+export const defaultAdminStoreRelations = []
+export const allowedAdminStoreRelations = []
+export const defaultAdminStoreFields = [
+  "id",
+  "name",
+  "default_sales_channel_id",
+  "default_region_id",
+  "default_location_id",
+  "metadata",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultAdminStoreFields,
+  defaultRelations: defaultAdminStoreRelations,
+  allowedRelations: allowedAdminStoreRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  defaultLimit: 20,
+  isList: true,
+}

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

@@ -0,0 +1,27 @@
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../types/routing"
+import { defaultAdminStoreFields } from "./query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "store",
+    variables: {
+      filters: req.filterableFields,
+      order: req.listConfig.order,
+      skip: req.listConfig.skip,
+      take: req.listConfig.take,
+    },
+    fields: defaultAdminStoreFields,
+  })
+
+  const { rows: stores, metadata } = await remoteQuery(queryObject)
+
+  res.json({
+    stores,
+    count: metadata.count,
+    offset: metadata.skip,
+    limit: metadata.take,
+  })
+}

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

@@ -0,0 +1,61 @@
+import { Type } from "class-transformer"
+import { IsObject, IsOptional, IsString, ValidateNested } from "class-validator"
+import { FindParams, extendedFindParamsMixin } from "../../../types/common"
+
+export class AdminGetStoresStoreParams extends FindParams {}
+/**
+ * Parameters used to filter and configure the pagination of the retrieved api keys.
+ */
+export class AdminGetStoresParams 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()
+  name?: string | string[]
+
+  // Additional filters from BaseFilterable
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetStoresParams)
+  $and?: AdminGetStoresParams[]
+
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetStoresParams)
+  $or?: AdminGetStoresParams[]
+}
+
+export class AdminPostStoresStoreReq {
+  @IsOptional()
+  @IsString()
+  name?: string
+
+  @IsOptional()
+  @IsString()
+  default_sales_channel_id?: string
+
+  @IsOptional()
+  @IsString()
+  default_region_id?: string
+
+  @IsOptional()
+  @IsString()
+  default_location_id?: string
+
+  @IsObject()
+  @IsOptional()
+  metadata?: Record<string, unknown>
+}
+
+export class AdminDeleteStoresStoreReq {}