feature/easypost as default shipment for marketplace

apps/backend/.env.template

@@ -8,5 +8,6 @@ COOKIE_SECRET=supersecret
 DATABASE_URL=postgres://[user]:[password]@[address]:[port]/$DB_NAME
 DB_NAME=
 
-STRIPE_SECRET_API_KEY=supersecret
-STRIPE_CONNECTED_ACCOUNTS_WEBHOOK_SECRET=supersecret
+STRIPE_SECRET_API_KEY=
+STRIPE_CONNECTED_ACCOUNTS_WEBHOOK_SECRET=
+EASYPOST_API_KEY=

apps/backend/medusa-config.ts

@@ -21,6 +21,7 @@ module.exports = defineConfig({
     { resolve: './src/modules/configuration' },
     { resolve: './src/modules/order-return-request' },
     { resolve: './src/modules/requests' },
+    { resolve: './src/modules/default-shipping-options' },
     {
       resolve: './src/modules/taxcode',
       options: {
@@ -47,6 +48,25 @@ module.exports = defineConfig({
           }
         ]
       }
+    },
+    {
+      resolve: '@medusajs/medusa/fulfillment',
+      options: {
+        providers: [
+          {
+            resolve: '@medusajs/medusa/fulfillment-manual',
+            id: 'manual'
+          },
+          {
+            resolve: './src/modules/easypost',
+            id: 'easypost',
+            options: {
+              apiKey: process.env.EASYPOST_API_KEY || 'supersecret',
+              mockEasyPostClient: true
+            }
+          }
+        ]
+      }
     }
   ]
 })

apps/backend/package.json

@@ -27,14 +27,15 @@
     "generate:oas": "medusa-oas oas --type combined --paths ./src/api"
   },
   "dependencies": {
-    "@medusajs/admin-sdk": "latest",
-    "@medusajs/cli": "^2.1.0",
-    "@medusajs/framework": "latest",
-    "@medusajs/medusa": "latest",
-    "@mikro-orm/core": "5.9.7",
-    "@mikro-orm/knex": "5.9.7",
-    "@mikro-orm/migrations": "5.9.7",
-    "@mikro-orm/postgresql": "5.9.7",
+    "@easypost/api": "^7.5.5",
+    "@medusajs/admin-sdk": "2.4.0",
+    "@medusajs/cli": "2.4.0",
+    "@medusajs/framework": "2.4.0",
+    "@medusajs/medusa": "2.4.0",
+    "@mikro-orm/core": "6.4.3",
+    "@mikro-orm/knex": "6.4.3",
+    "@mikro-orm/migrations": "6.4.3",
+    "@mikro-orm/postgresql": "6.4.3",
     "awilix": "^8.0.1",
     "pg": "^8.13.0",
     "stripe": "^17.4.0"
@@ -43,7 +44,7 @@
     "@eslint/js": "^9.15.0",
     "@medusajs/medusa-oas-cli": "^2.1.0",
     "@medusajs/test-utils": "latest",
-    "@mikro-orm/cli": "5.9.7",
+    "@mikro-orm/cli": "6.4.3",
     "@swc/core": "1.5.7",
     "@swc/jest": "^0.2.36",
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",

apps/backend/src/api/admin/default-shipping-option/easypost/route.ts

@@ -0,0 +1,40 @@
+import { getEasyPostOptions } from '#/workflows/default-shipping-options/workflows'
+
+import { MedusaRequest, MedusaResponse } from '@medusajs/framework/http'
+
+// TODO OAS to be fixed
+/**
+ * @oas [get] /admin/default-shipping-option/easypost
+ * operationId: "GetDefaultShippingOptionEasypost"
+ * summary: "List EasyPost Shipping Options"
+ * description: "Retrieves a list of available shipping options from EasyPost."
+ * x-authenticated: true
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ * tags:
+ *   - Default Shipping Option
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           type: object
+ *           properties:
+ *             result:
+ *               type: array
+ *               items:
+ *                 type: object
+ *                 properties:
+ *                   id:
+ *                     type: string
+ *                     description: The EasyPost shipping option ID
+ *                   name:
+ *                     type: string
+ *                     description: The name of the shipping option
+ */
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const { result } = await getEasyPostOptions(req.scope).run()
+  res.json(result)
+}

apps/backend/src/api/admin/default-shipping-option/middlewares.ts

@@ -0,0 +1,25 @@
+import {
+  MiddlewareRoute,
+  validateAndTransformBody,
+  validateAndTransformQuery
+} from '@medusajs/framework'
+
+import { AdminCreateDefaultSippingOption } from './validators'
+
+export const defaultShippingOptionMiddlewares: MiddlewareRoute[] = [
+  // {
+  //   method: ['GET'],
+  //   matcher: '/admin/default-shipping-option',
+  //   middlewares: [validateAndTransformQuery(, {})]
+  // },
+  {
+    method: ['POST'],
+    matcher: '/admin/default-shipping-option',
+    middlewares: [validateAndTransformBody(AdminCreateDefaultSippingOption)]
+  }
+  // {
+  //   method: ['POST'],
+  //   matcher: '/admin/default-shipping-option/:id',
+  //   middlewares: [validateAndTransformBody()]
+  // }
+]

apps/backend/src/api/admin/default-shipping-option/route.ts

@@ -0,0 +1,23 @@
+import { MedusaRequest, MedusaResponse } from '@medusajs/framework/http'
+
+import { AdminCreateDefaultShippingOptionType } from './validators'
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  // const carriers = await getAdminCarriersList(req.scope).run()
+  const query = req.scope.resolve('query')
+
+  const { data } = await query.graph({
+    entity: 'default_shipping_option',
+    fields: ['*']
+  })
+  res.json(data)
+}
+
+export const POST = async (
+  req: MedusaRequest<AdminCreateDefaultShippingOptionType>,
+  res: MedusaResponse
+) => {
+  // const carriers = await getAdminCarriersList(req.scope).run()
+
+  res.send('To be implemented')
+}

apps/backend/src/api/admin/default-shipping-option/validators.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod'
+
+/**
+ * @schema AdminCreateDefaultSippingOption
+ * type: object
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The external id from easypost api.
+ */
+export type AdminCreateDefaultShippingOptionType = z.infer<
+  typeof AdminCreateDefaultSippingOption
+>
+export const AdminCreateDefaultSippingOption = z.object({
+  id: z.string()
+})

apps/backend/src/api/admin/middlewares.ts

@@ -1,6 +1,7 @@
 import { MiddlewareRoute } from '@medusajs/framework'
 
 import { configurationMiddleware } from './configuration/middlewares'
+import { defaultShippingOptionMiddlewares } from './default-shipping-option/middlewares'
 import { orderSetsMiddlewares } from './order-sets/middlewares'
 import { requestsMiddlewares } from './requests/middlewares'
 import { returnRequestsMiddlewares } from './return-request/middlewares'
@@ -9,5 +10,6 @@ export const adminMiddlewares: MiddlewareRoute[] = [
   ...orderSetsMiddlewares,
   ...requestsMiddlewares,
   ...configurationMiddleware,
-  ...returnRequestsMiddlewares
+  ...returnRequestsMiddlewares,
+  ...defaultShippingOptionMiddlewares
 ]

apps/backend/src/links/seller-default-shipping-option.ts

@@ -0,0 +1,9 @@
+import { defineLink } from '@medusajs/framework/utils'
+
+import DefaultShippingOptionModule from '../modules/default-shipping-options'
+import SellerModule from '../modules/seller'
+
+export default defineLink(SellerModule.linkable.seller, {
+  linkable: DefaultShippingOptionModule.linkable.defaultSellerShippingOption,
+  isList: true
+})

apps/backend/src/modules/default-shipping-options/index.ts

@@ -0,0 +1,9 @@
+import { Module } from '@medusajs/framework/utils'
+
+import DefaultShippingOptionModuleService from './service'
+
+export const DEFAULT_SHIPPING_OPTION_MODULE = 'default_shipping_option'
+
+export default Module(DEFAULT_SHIPPING_OPTION_MODULE, {
+  service: DefaultShippingOptionModuleService
+})