@pradip1995/framework-compiler 0.2.6 → 0.3.0

package/backend-templates/plugin-definitions.cjs

@@ -0,0 +1,124 @@
+/**
+ * Medusa plugin entries keyed by npm package name.
+ * Used by generate-medusa-config.cjs to build medusa-config.ts from plugins.config.json.
+ */
+module.exports = {
+  "medusa-product-helper": {
+    resolve: "medusa-product-helper",
+    options: {},
+  },
+  "stock-monitoring": {
+    resolve: "stock-monitoring",
+    options: { low_stock_threshold: 10, slow_moving_days_threshold: 90 },
+  },
+  "medusa-invoice-sbl": {
+    resolve: "medusa-invoice-sbl",
+    options: {
+      attachInvoiceToEmail: true,
+      guestJwtSecret: "process.env.JWT_SECRET",
+    },
+  },
+  "medusa-dynamic-metadata": {
+    resolve: "medusa-dynamic-metadata",
+    options: {
+      entities: {
+        products: {
+          descriptors: "PRODUCT_METADATA_DESCRIPTORS",
+          expose_client_helpers: true,
+          filterable: true,
+        },
+        categories: {
+          descriptors: [
+            { key: "category_image", label: "Category Image", type: "file" },
+            { key: "category_background_color", label: "Category Background Color", type: "text" },
+          ],
+        },
+        collections: {
+          descriptors: [
+            { key: "collection_icon", label: "Collection Icon", type: "file" },
+            {
+              key: "home_featured",
+              label: "Show on Home",
+              type: "select",
+              options: [
+                { value: "true", label: "Yes" },
+                { value: "false", label: "No" },
+              ],
+            },
+          ],
+        },
+        product_variants: {
+          descriptors: [{ key: "variant_image", label: "Variant Image", type: "file" }],
+        },
+      },
+    },
+  },
+  "medusa-review-rating": {
+    resolve: "medusa-review-rating",
+    options: { autoApprove: true, requireVerifiedPurchase: false, multiple_rating: true },
+  },
+  "medusa-plugin-dynamic-config": {
+    resolve: "medusa-plugin-dynamic-config",
+    options: {
+      configs: { "homepage-config": "homepageConfig" },
+    },
+  },
+  "medusa-contact-us": {
+    resolve: "medusa-contact-us",
+    options: {
+      default_status: "pending",
+      payload_fields: [
+        { key: "full_name", type: "text", required: true, label: "Full Name" },
+        { key: "email", type: "text", required: true, label: "Email" },
+        { key: "message", type: "textarea", required: true, label: "Message" },
+      ],
+      allowed_statuses: ["pending", "in_progress", "resolved", "closed"],
+    },
+  },
+  "order-management": {
+    resolve: "order-management",
+    options: {
+      jwtSecret: "process.env.JWT_SECRET",
+      storefrontUrl: "storefrontUrl",
+    },
+  },
+  "customer-registration": {
+    resolve: "customer-registration",
+    options: {
+      storefrontUrl: "storefrontUrl",
+      registration: { identifier: "both", require_verification: true },
+      login: { identifier: "both" },
+    },
+  },
+  "medusa-shiprocket-fulfillment-sbl": {
+    resolve: "medusa-shiprocket-fulfillment-sbl",
+    options: {
+      shiprocket: {
+        email: "process.env.SHIPROCKET_EMAIL",
+        password: "process.env.SHIPROCKET_PASSWORD",
+        pickupLocation: 'process.env.SHIPROCKET_PICKUP_LOCATION || "Primary"',
+      },
+      webhookSecret: "process.env.SHIPROCKET_WEBHOOK_SECRET",
+    },
+  },
+  "medusa-notification-token-management": {
+    resolve: "medusa-notification-token-management",
+    options: {},
+  },
+  "medusa-customer-file-upload": {
+    resolve: "medusa-customer-file-upload",
+    options: {},
+  },
+  "medusa-analytics": {
+    resolveSpecial: "medusa-analytics",
+    options: {},
+  },
+  "medusa-export": {
+    resolve: "medusa-export",
+    options: {},
+  },
+  "medusa-payment-provider": {
+    resolve: "medusa-payment-provider",
+    options: {},
+  },
+}

package/backend-templates/product-metadata-descriptors.ts

@@ -0,0 +1,27 @@
+/** Minimal product metadata for storefront filters and PDP specs */
+export const PRODUCT_METADATA_DESCRIPTORS = [
+  {
+    key: "style",
+    label: "Style",
+    type: "select",
+    filterable: true,
+    options: [
+      { value: "casual", label: "Casual" },
+      { value: "formal", label: "Formal" },
+      { value: "festive", label: "Festive" },
+    ],
+  },
+  {
+    key: "fabric",
+    label: "Fabric",
+    type: "select",
+    filterable: true,
+    options: [
+      { value: "cotton", label: "Cotton" },
+      { value: "silk", label: "Silk" },
+      { value: "linen", label: "Linen" },
+    ],
+  },
+  { key: "size_fit", label: "Size & Fit", type: "textarea" },
+  { key: "material_care", label: "Material & Care", type: "textarea" },
+]

package/backend-templates/scripts/build-dynamic-config-defaults.mjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/**
+ * Regenerate config/homepage-config.defaults.json from config/homepage-config.json.
+ * Run after editing the schema structure in the backend.
+ */
+import { readFileSync, writeFileSync } from "fs"
+import { join, dirname } from "path"
+import { fileURLToPath } from "url"
+import { createRequire } from "module"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const backendRoot = join(__dirname, "..")
+const require = createRequire(import.meta.url)
+const { buildHomepageConfigDefaults } = require("./build-homepage-defaults.cjs")
+
+const schemaPath = join(backendRoot, "config/homepage-config.json")
+const schema = JSON.parse(readFileSync(schemaPath, "utf8"))
+const defaults = buildHomepageConfigDefaults(schema)
+
+writeFileSync(
+  join(backendRoot, "config/homepage-config.defaults.json"),
+  `${JSON.stringify(defaults, null, 2)}\n`
+)
+
+console.log("Wrote config/homepage-config.defaults.json")

package/backend-templates/scripts/build-homepage-defaults.cjs

@@ -0,0 +1,50 @@
+/**
+ * Build initial homepage-config values from schema structure defaultValue fields.
+ * Copied into each scaffolded backend at scripts/build-homepage-defaults.cjs
+ */
+
+function buildDefaultsFromStructure(fields) {
+  const result = {}
+  for (const field of fields) {
+    const value = buildDefaultForField(field)
+    if (value !== undefined) {
+      result[field.id] = value
+    }
+  }
+  return result
+}
+
+function buildDefaultForField(field) {
+  if (field.defaultValue !== undefined) {
+    return field.defaultValue
+  }
+
+  if (field.type === "object" && field.children?.length) {
+    const nested = buildDefaultsFromStructure(field.children)
+    return Object.keys(nested).length > 0 ? nested : undefined
+  }
+
+  if (field.type === "array" && field.children?.length) {
+    const [itemSchema] = field.children
+    if (itemSchema?.type === "object" && itemSchema.children?.length) {
+      const itemDefaults = buildDefaultsFromStructure(itemSchema.children)
+      if (Object.keys(itemDefaults).length > 0) {
+        return [{ [itemSchema.id]: itemDefaults }]
+      }
+    }
+    return undefined
+  }
+
+  return undefined
+}
+
+function buildHomepageConfigDefaults(configSchema) {
+  if (!configSchema?.structure?.length) return {}
+  return buildDefaultsFromStructure(configSchema.structure)
+}
+
+module.exports = {
+  buildDefaultsFromStructure,
+  buildDefaultForField,
+  buildHomepageConfigDefaults,
+}

package/backend-templates/seed.ts

@@ -0,0 +1,210 @@
+import type { ExecArgs } from "@medusajs/framework/types"
+import {
+  ContainerRegistrationKeys,
+  Modules,
+  ProductStatus,
+} from "@medusajs/framework/utils"
+import {
+  createApiKeysWorkflow,
+  createInventoryLevelsWorkflow,
+  createProductCategoriesWorkflow,
+  createProductsWorkflow,
+  createRegionsWorkflow,
+  createSalesChannelsWorkflow,
+  createShippingOptionsWorkflow,
+  createShippingProfilesWorkflow,
+  createStockLocationsWorkflow,
+  createTaxRegionsWorkflow,
+  linkSalesChannelsToApiKeyWorkflow,
+  linkSalesChannelsToStockLocationWorkflow,
+  updateStoresWorkflow,
+} from "@medusajs/medusa/core-flows"
+
+const SEED_COUNTRIES = ["{{DEFAULT_REGION}}"]
+const SEED_CURRENCY = "{{DEFAULT_CURRENCY}}"
+const SEED_REGION_NAME = "{{DEFAULT_REGION_NAME}}"
+
+export default async function seedStore({ container }: ExecArgs) {
+  const logger = container.resolve(ContainerRegistrationKeys.LOGGER)
+  const link = container.resolve(ContainerRegistrationKeys.LINK)
+  const fulfillmentModuleService = container.resolve(Modules.FULFILLMENT)
+  const salesChannelModuleService = container.resolve(Modules.SALES_CHANNEL)
+  const storeModuleService = container.resolve(Modules.STORE)
+
+  logger.info("Seeding store...")
+  const [store] = await storeModuleService.listStores()
+
+  let [salesChannel] = await salesChannelModuleService.listSalesChannels({
+    name: "Default Sales Channel",
+  })
+  if (!salesChannel) {
+    const { result } = await createSalesChannelsWorkflow(container).run({
+      input: { salesChannelsData: [{ name: "Default Sales Channel" }] },
+    })
+    salesChannel = result[0]
+  }
+
+  await updateStoresWorkflow(container).run({
+    input: {
+      selector: { id: store.id },
+      update: {
+        default_sales_channel_id: salesChannel.id,
+        supported_currencies: [{ currency_code: SEED_CURRENCY, is_default: true }],
+      },
+    },
+  })
+
+  logger.info("Seeding region...")
+  const { result: regions } = await createRegionsWorkflow(container).run({
+    input: {
+      regions: [
+        {
+          name: SEED_REGION_NAME,
+          currency_code: SEED_CURRENCY,
+          countries: SEED_COUNTRIES,
+          payment_providers: ["pp_system_default"],
+        },
+      ],
+    },
+  })
+  const region = regions[0]
+
+  await createTaxRegionsWorkflow(container).run({
+    input: SEED_COUNTRIES.map((country_code) => ({
+      country_code,
+      provider_id: "tp_system",
+    })),
+  })
+
+  const { result: stockLocations } = await createStockLocationsWorkflow(container).run({
+    input: {
+      locations: [
+        {
+          name: "Primary Warehouse",
+          address: { city: "Default", country_code: SEED_COUNTRIES[0], address_1: "" },
+        },
+      ],
+    },
+  })
+  const stockLocation = stockLocations[0]
+
+  await updateStoresWorkflow(container).run({
+    input: {
+      selector: { id: store.id },
+      update: { default_location_id: stockLocation.id },
+    },
+  })
+
+  await link.create({
+    [Modules.STOCK_LOCATION]: { stock_location_id: stockLocation.id },
+    [Modules.FULFILLMENT]: { fulfillment_provider_id: "manual_manual" },
+  })
+
+  const shippingProfiles = await fulfillmentModuleService.listShippingProfiles({ type: "default" })
+  let shippingProfile = shippingProfiles[0]
+  if (!shippingProfile) {
+    const { result } = await createShippingProfilesWorkflow(container).run({
+      input: { data: [{ name: "Default Shipping Profile", type: "default" }] },
+    })
+    shippingProfile = result[0]
+  }
+
+  const fulfillmentSet = await fulfillmentModuleService.createFulfillmentSets({
+    name: "Primary delivery",
+    type: "shipping",
+    service_zones: [
+      {
+        name: SEED_REGION_NAME,
+        geo_zones: SEED_COUNTRIES.map((country_code) => ({ country_code, type: "country" as const })),
+      },
+    ],
+  })
+
+  await link.create({
+    [Modules.STOCK_LOCATION]: { stock_location_id: stockLocation.id },
+    [Modules.FULFILLMENT]: { fulfillment_set_id: fulfillmentSet.id },
+  })
+
+  await createShippingOptionsWorkflow(container).run({
+    input: [
+      {
+        name: "Standard Shipping",
+        price_type: "flat",
+        provider_id: "manual_manual",
+        service_zone_id: fulfillmentSet.service_zones[0].id,
+        shipping_profile_id: shippingProfile.id,
+        type: { label: "Standard", description: "Ship in 2-5 days.", code: "standard" },
+        prices: [{ currency_code: SEED_CURRENCY, amount: 0 }, { region_id: region.id, amount: 0 }],
+        rules: [
+          { attribute: "enabled_in_store", value: "true", operator: "eq" },
+          { attribute: "is_return", value: "false", operator: "eq" },
+        ],
+      },
+    ],
+  })
+
+  await linkSalesChannelsToStockLocationWorkflow(container).run({
+    input: { id: stockLocation.id, add: [salesChannel.id] },
+  })
+
+  logger.info("Creating publishable API key...")
+  const { result: apiKeys } = await createApiKeysWorkflow(container).run({
+    input: {
+      api_keys: [{ title: "Storefront", type: "publishable", created_by: "" }],
+    },
+  })
+  const publishableKey = apiKeys[0]
+  await linkSalesChannelsToApiKeyWorkflow(container).run({
+    input: { id: publishableKey.id, add: [salesChannel.id] },
+  })
+
+  logger.info("Seeding sample category and product...")
+  const { result: categories } = await createProductCategoriesWorkflow(container).run({
+    input: { product_categories: [{ name: "Featured", is_active: true }] },
+  })
+
+  const { result: products } = await createProductsWorkflow(container).run({
+    input: {
+      products: [
+        {
+          title: "Sample Product",
+          handle: "sample-product",
+          status: ProductStatus.PUBLISHED,
+          category_ids: [categories[0].id],
+          options: [{ title: "Size", values: ["S", "M", "L"] }],
+          variants: [
+            {
+              title: "S",
+              sku: "SAMPLE-S",
+              options: { Size: "S" },
+              prices: [{ currency_code: SEED_CURRENCY, amount: 999 }],
+            },
+          ],
+          sales_channels: [{ id: salesChannel.id }],
+        },
+      ],
+    },
+  })
+
+  const inventoryModule = container.resolve(Modules.INVENTORY)
+  const inventoryItems = await inventoryModule.listInventoryItems({ sku: "SAMPLE-S" })
+  if (inventoryItems[0]) {
+    await createInventoryLevelsWorkflow(container).run({
+      input: {
+        inventory_levels: [
+          {
+            inventory_item_id: inventoryItems[0].id,
+            location_id: stockLocation.id,
+            stocked_quantity: 100,
+          },
+        ],
+      },
+    })
+  }
+
+  logger.info("")
+  logger.info("=== Seed complete ===")
+  logger.info(`Region: ${SEED_REGION_NAME} (${SEED_COUNTRIES.join(", ")})`)
+  logger.info(`Publishable API key id: ${publishableKey.id}`)
+  logger.info(`Sample product: ${products[0]?.handle}`)
+}

package/backend-templates/src/config/product-metadata-descriptors.ts

@@ -0,0 +1,27 @@
+/** Minimal product metadata for storefront filters and PDP specs */
+export const PRODUCT_METADATA_DESCRIPTORS = [
+  {
+    key: "style",
+    label: "Style",
+    type: "select",
+    filterable: true,
+    options: [
+      { value: "casual", label: "Casual" },
+      { value: "formal", label: "Formal" },
+      { value: "festive", label: "Festive" },
+    ],
+  },
+  {
+    key: "fabric",
+    label: "Fabric",
+    type: "select",
+    filterable: true,
+    options: [
+      { value: "cotton", label: "Cotton" },
+      { value: "silk", label: "Silk" },
+      { value: "linen", label: "Linen" },
+    ],
+  },
+  { key: "size_fit", label: "Size & Fit", type: "textarea" },
+  { key: "material_care", label: "Material & Care", type: "textarea" },
+]

package/backend-templates/src/scripts/seed.ts

@@ -0,0 +1,210 @@
+import type { ExecArgs } from "@medusajs/framework/types"
+import {
+  ContainerRegistrationKeys,
+  Modules,
+  ProductStatus,
+} from "@medusajs/framework/utils"
+import {
+  createApiKeysWorkflow,
+  createInventoryLevelsWorkflow,
+  createProductCategoriesWorkflow,
+  createProductsWorkflow,
+  createRegionsWorkflow,
+  createSalesChannelsWorkflow,
+  createShippingOptionsWorkflow,
+  createShippingProfilesWorkflow,
+  createStockLocationsWorkflow,
+  createTaxRegionsWorkflow,
+  linkSalesChannelsToApiKeyWorkflow,
+  linkSalesChannelsToStockLocationWorkflow,
+  updateStoresWorkflow,
+} from "@medusajs/medusa/core-flows"
+
+const SEED_COUNTRIES = ["{{DEFAULT_REGION}}"]
+const SEED_CURRENCY = "{{DEFAULT_CURRENCY}}"
+const SEED_REGION_NAME = "{{DEFAULT_REGION_NAME}}"
+
+export default async function seedStore({ container }: ExecArgs) {
+  const logger = container.resolve(ContainerRegistrationKeys.LOGGER)
+  const link = container.resolve(ContainerRegistrationKeys.LINK)
+  const fulfillmentModuleService = container.resolve(Modules.FULFILLMENT)
+  const salesChannelModuleService = container.resolve(Modules.SALES_CHANNEL)
+  const storeModuleService = container.resolve(Modules.STORE)
+
+  logger.info("Seeding store...")
+  const [store] = await storeModuleService.listStores()
+
+  let [salesChannel] = await salesChannelModuleService.listSalesChannels({
+    name: "Default Sales Channel",
+  })
+  if (!salesChannel) {
+    const { result } = await createSalesChannelsWorkflow(container).run({
+      input: { salesChannelsData: [{ name: "Default Sales Channel" }] },
+    })
+    salesChannel = result[0]
+  }
+
+  await updateStoresWorkflow(container).run({
+    input: {
+      selector: { id: store.id },
+      update: {
+        default_sales_channel_id: salesChannel.id,
+        supported_currencies: [{ currency_code: SEED_CURRENCY, is_default: true }],
+      },
+    },
+  })
+
+  logger.info("Seeding region...")
+  const { result: regions } = await createRegionsWorkflow(container).run({
+    input: {
+      regions: [
+        {
+          name: SEED_REGION_NAME,
+          currency_code: SEED_CURRENCY,
+          countries: SEED_COUNTRIES,
+          payment_providers: ["pp_system_default"],
+        },
+      ],
+    },
+  })
+  const region = regions[0]
+
+  await createTaxRegionsWorkflow(container).run({
+    input: SEED_COUNTRIES.map((country_code) => ({
+      country_code,
+      provider_id: "tp_system",
+    })),
+  })
+
+  const { result: stockLocations } = await createStockLocationsWorkflow(container).run({
+    input: {
+      locations: [
+        {
+          name: "Primary Warehouse",
+          address: { city: "Default", country_code: SEED_COUNTRIES[0], address_1: "" },
+        },
+      ],
+    },
+  })
+  const stockLocation = stockLocations[0]
+
+  await updateStoresWorkflow(container).run({
+    input: {
+      selector: { id: store.id },
+      update: { default_location_id: stockLocation.id },
+    },
+  })
+
+  await link.create({
+    [Modules.STOCK_LOCATION]: { stock_location_id: stockLocation.id },
+    [Modules.FULFILLMENT]: { fulfillment_provider_id: "manual_manual" },
+  })
+
+  const shippingProfiles = await fulfillmentModuleService.listShippingProfiles({ type: "default" })
+  let shippingProfile = shippingProfiles[0]
+  if (!shippingProfile) {
+    const { result } = await createShippingProfilesWorkflow(container).run({
+      input: { data: [{ name: "Default Shipping Profile", type: "default" }] },
+    })
+    shippingProfile = result[0]
+  }
+
+  const fulfillmentSet = await fulfillmentModuleService.createFulfillmentSets({
+    name: "Primary delivery",
+    type: "shipping",
+    service_zones: [
+      {
+        name: SEED_REGION_NAME,
+        geo_zones: SEED_COUNTRIES.map((country_code) => ({ country_code, type: "country" as const })),
+      },
+    ],
+  })
+
+  await link.create({
+    [Modules.STOCK_LOCATION]: { stock_location_id: stockLocation.id },
+    [Modules.FULFILLMENT]: { fulfillment_set_id: fulfillmentSet.id },
+  })
+
+  await createShippingOptionsWorkflow(container).run({
+    input: [
+      {
+        name: "Standard Shipping",
+        price_type: "flat",
+        provider_id: "manual_manual",
+        service_zone_id: fulfillmentSet.service_zones[0].id,
+        shipping_profile_id: shippingProfile.id,
+        type: { label: "Standard", description: "Ship in 2-5 days.", code: "standard" },
+        prices: [{ currency_code: SEED_CURRENCY, amount: 0 }, { region_id: region.id, amount: 0 }],
+        rules: [
+          { attribute: "enabled_in_store", value: "true", operator: "eq" },
+          { attribute: "is_return", value: "false", operator: "eq" },
+        ],
+      },
+    ],
+  })
+
+  await linkSalesChannelsToStockLocationWorkflow(container).run({
+    input: { id: stockLocation.id, add: [salesChannel.id] },
+  })
+
+  logger.info("Creating publishable API key...")
+  const { result: apiKeys } = await createApiKeysWorkflow(container).run({
+    input: {
+      api_keys: [{ title: "Storefront", type: "publishable", created_by: "" }],
+    },
+  })
+  const publishableKey = apiKeys[0]
+  await linkSalesChannelsToApiKeyWorkflow(container).run({
+    input: { id: publishableKey.id, add: [salesChannel.id] },
+  })
+
+  logger.info("Seeding sample category and product...")
+  const { result: categories } = await createProductCategoriesWorkflow(container).run({
+    input: { product_categories: [{ name: "Featured", is_active: true }] },
+  })
+
+  const { result: products } = await createProductsWorkflow(container).run({
+    input: {
+      products: [
+        {
+          title: "Sample Product",
+          handle: "sample-product",
+          status: ProductStatus.PUBLISHED,
+          category_ids: [categories[0].id],
+          options: [{ title: "Size", values: ["S", "M", "L"] }],
+          variants: [
+            {
+              title: "S",
+              sku: "SAMPLE-S",
+              options: { Size: "S" },
+              prices: [{ currency_code: SEED_CURRENCY, amount: 999 }],
+            },
+          ],
+          sales_channels: [{ id: salesChannel.id }],
+        },
+      ],
+    },
+  })
+
+  const inventoryModule = container.resolve(Modules.INVENTORY)
+  const inventoryItems = await inventoryModule.listInventoryItems({ sku: "SAMPLE-S" })
+  if (inventoryItems[0]) {
+    await createInventoryLevelsWorkflow(container).run({
+      input: {
+        inventory_levels: [
+          {
+            inventory_item_id: inventoryItems[0].id,
+            location_id: stockLocation.id,
+            stocked_quantity: 100,
+          },
+        ],
+      },
+    })
+  }
+
+  logger.info("")
+  logger.info("=== Seed complete ===")
+  logger.info(`Region: ${SEED_REGION_NAME} (${SEED_COUNTRIES.join(", ")})`)
+  logger.info(`Publishable API key id: ${publishableKey.id}`)
+  logger.info(`Sample product: ${products[0]?.handle}`)
+}

package/backend-templates/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "esModuleInterop": true,
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "declaration": false,
+    "outDir": "./.medusa/server",
+    "rootDir": "./",
+    "jsx": "react-jsx",
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "strictNullChecks": true
+  },
+  "ts-node": {
+    "compiler": "typescript",
+    "transpileOnly": true
+  },
+  "include": ["**/*", ".medusa/types/*"],
+  "exclude": ["node_modules", ".medusa/server", ".medusa/admin", ".cache"]
+}