@pradip1995/create-storefront-app 0.2.3 → 0.3.0

package/templates/backend/medusa-config.full.ts

@@ -0,0 +1,251 @@
+import path from "path"
+import { createRequire } from "module"
+import { loadEnv, defineConfig, Modules, ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import homepageConfig from "./config/homepage-config.json"
+import { PRODUCT_METADATA_DESCRIPTORS } from "./src/config/product-metadata-descriptors"
+
+const require = createRequire(import.meta.url)
+
+loadEnv(process.env.NODE_ENV || "development", process.cwd())
+
+const storefrontUrl = process.env.STOREFRONT_URL || "http://localhost:8000"
+const defaultRegion = process.env.SEED_DEFAULT_REGION || "in"
+
+module.exports = defineConfig({
+  projectConfig: {
+    databaseUrl: process.env.DATABASE_URL,
+    http: {
+      storeCors: process.env.STORE_CORS!,
+      adminCors: process.env.ADMIN_CORS!,
+      authCors: process.env.AUTH_CORS!,
+      jwtSecret: process.env.JWT_SECRET || "supersecret",
+      cookieSecret: process.env.COOKIE_SECRET || "supersecret",
+    },
+    cookieOptions: {
+      sameSite: "lax",
+      secure: process.env.NODE_ENV === "production",
+    },
+  },
+  plugins: [
+    { resolve: "medusa-product-helper", options: {} },
+    {
+      resolve: "stock-monitoring",
+      options: { low_stock_threshold: 10, slow_moving_days_threshold: 90 },
+    },
+    {
+      resolve: "medusa-invoice-sbl",
+      options: {
+        attachInvoiceToEmail: true,
+        guestJwtSecret: process.env.JWT_SECRET,
+      },
+    },
+    {
+      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" }],
+          },
+        },
+      },
+    },
+    {
+      resolve: "medusa-review-rating",
+      options: { autoApprove: true, requireVerifiedPurchase: false, multiple_rating: true },
+    },
+    {
+      resolve: "medusa-plugin-dynamic-config",
+      options: { configs: { "homepage-config": homepageConfig } },
+    },
+    {
+      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"],
+      },
+    },
+    {
+      resolve: "order-management",
+      options: {
+        jwtSecret: process.env.JWT_SECRET,
+        storefrontUrl,
+      },
+    },
+    {
+      resolve: "customer-registration",
+      options: {
+        storefrontUrl,
+        registration: { identifier: "both", require_verification: true },
+        login: { identifier: "both" },
+      },
+    },
+    {
+      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,
+      },
+    },
+    { resolve: "medusa-notification-token-management", options: {} },
+    { resolve: "medusa-customer-file-upload", options: {} },
+    {
+      resolve: path.dirname(require.resolve("medusa-analytics/package.json")),
+      options: {},
+    },
+    { resolve: "medusa-export", options: {} },
+    { resolve: "medusa-payment-provider", options: {} },
+  ],
+  modules: {
+    [Modules.AUTH]: {
+      resolve: "@medusajs/medusa/auth",
+      dependencies: [Modules.CACHE, ContainerRegistrationKeys.LOGGER],
+      options: {
+        providers: [
+          { resolve: "@medusajs/medusa/auth-emailpass", id: "emailpass" },
+          { resolve: "customer-registration/providers/phonepass", id: "phonepass" },
+          ...(process.env.GOOGLE_CLIENT_ID
+            ? [
+                {
+                  resolve: "@medusajs/auth-google",
+                  id: "google",
+                  options: {
+                    clientId: process.env.GOOGLE_CLIENT_ID,
+                    clientSecret: process.env.GOOGLE_CLIENT_SECRET,
+                  },
+                },
+              ]
+            : []),
+        ],
+      },
+    },
+    [Modules.FULFILLMENT]: {
+      resolve: "@medusajs/medusa/fulfillment",
+      options: {
+        providers: [
+          { resolve: "@medusajs/medusa/fulfillment-manual", id: "manual" },
+          ...(process.env.SHIPROCKET_EMAIL
+            ? [
+                {
+                  resolve: "medusa-shiprocket-fulfillment-sbl",
+                  id: "shiprocket",
+                },
+              ]
+            : []),
+        ],
+      },
+    },
+    ...(process.env.CASHFREE_CLIENT_ID
+      ? {
+          [Modules.PAYMENT]: {
+            resolve: "@medusajs/medusa/payment",
+            options: {
+              providers: [
+                {
+                  resolve: "medusa-payment-provider/providers/cashfree",
+                  id: "cashfree",
+                  options: {
+                    client_id: process.env.CASHFREE_CLIENT_ID,
+                    client_secret: process.env.CASHFREE_CLIENT_SECRET,
+                    environment:
+                      process.env.CASHFREE_ENVIRONMENT === "production" ? "production" : "sandbox",
+                    return_url: `${storefrontUrl}/${defaultRegion}/checkout/payment/callback`,
+                  },
+                },
+              ],
+            },
+          },
+        }
+      : {}),
+    ...(process.env.SMTP_HOST
+      ? {
+          [Modules.NOTIFICATION]: {
+            resolve: "@medusajs/medusa/notification",
+            options: {
+              providers: [
+                {
+                  resolve: "@tsc_tech/medusa-plugin-smtp/providers/smtp",
+                  id: "smtp",
+                  options: {
+                    host: process.env.SMTP_HOST,
+                    port: Number(process.env.SMTP_PORT) || 465,
+                    secure: process.env.SMTP_SECURE === "true",
+                    auth: {
+                      user: process.env.SMTP_USER,
+                      pass: process.env.SMTP_PASS,
+                    },
+                    from: process.env.SMTP_FROM || process.env.SMTP_USER,
+                  },
+                },
+              ],
+            },
+          },
+        }
+      : {}),
+    file: {
+      resolve: "@medusajs/medusa/file",
+      options: {
+        providers: [
+          ...(process.env.AWS_BUCKET
+            ? [
+                {
+                  resolve: "@medusajs/medusa/file-s3",
+                  id: "s3",
+                  options: {
+                    file_url: process.env.AWS_FILE_URL,
+                    access_key_id: process.env.AWS_ACCESS_KEY,
+                    secret_access_key: process.env.AWS_SECRET_ACCESS_KEY,
+                    region: process.env.AWS_REGION,
+                    bucket: process.env.AWS_BUCKET,
+                    prefix: "uploads",
+                  },
+                },
+              ]
+            : [
+                {
+                  resolve: "@medusajs/medusa/file-local",
+                  id: "local",
+                  options: {
+                    upload_dir: "static",
+                    backend_url: `${process.env.MEDUSA_BACKEND_URL || "http://localhost:9000"}/static`,
+                  },
+                },
+              ]),
+        ],
+      },
+    },
+  },
+})

package/templates/backend/medusa-config.minimal.ts

@@ -0,0 +1,141 @@
+import { loadEnv, defineConfig, Modules, ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import homepageConfig from "./config/homepage-config.json"
+import { PRODUCT_METADATA_DESCRIPTORS } from "./src/config/product-metadata-descriptors"
+
+loadEnv(process.env.NODE_ENV || "development", process.cwd())
+
+module.exports = defineConfig({
+  projectConfig: {
+    databaseUrl: process.env.DATABASE_URL,
+    http: {
+      storeCors: process.env.STORE_CORS!,
+      adminCors: process.env.ADMIN_CORS!,
+      authCors: process.env.AUTH_CORS!,
+      jwtSecret: process.env.JWT_SECRET || "supersecret",
+      cookieSecret: process.env.COOKIE_SECRET || "supersecret",
+    },
+    cookieOptions: {
+      sameSite: "lax",
+      secure: process.env.NODE_ENV === "production",
+    },
+  },
+  plugins: [
+    { resolve: "medusa-product-helper", options: {} },
+    {
+      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" }],
+          },
+        },
+      },
+    },
+    {
+      resolve: "medusa-review-rating",
+      options: {
+        autoApprove: true,
+        requireVerifiedPurchase: false,
+        multiple_rating: true,
+      },
+    },
+    {
+      resolve: "medusa-plugin-dynamic-config",
+      options: {
+        configs: {
+          "homepage-config": homepageConfig,
+        },
+      },
+    },
+    {
+      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"],
+      },
+    },
+    {
+      resolve: "customer-registration",
+      options: {
+        storefrontUrl: process.env.STOREFRONT_URL || "http://localhost:8000",
+        registration: { identifier: "both", require_verification: true },
+        login: { identifier: "both" },
+      },
+    },
+  ],
+  modules: {
+    [Modules.AUTH]: {
+      resolve: "@medusajs/medusa/auth",
+      dependencies: [Modules.CACHE, ContainerRegistrationKeys.LOGGER],
+      options: {
+        providers: [
+          { resolve: "@medusajs/medusa/auth-emailpass", id: "emailpass" },
+          { resolve: "customer-registration/providers/phonepass", id: "phonepass" },
+          ...(process.env.GOOGLE_CLIENT_ID
+            ? [
+                {
+                  resolve: "@medusajs/auth-google",
+                  id: "google",
+                  options: {
+                    clientId: process.env.GOOGLE_CLIENT_ID,
+                    clientSecret: process.env.GOOGLE_CLIENT_SECRET,
+                  },
+                },
+              ]
+            : []),
+        ],
+      },
+    },
+    [Modules.FULFILLMENT]: {
+      resolve: "@medusajs/medusa/fulfillment",
+      options: {
+        providers: [{ resolve: "@medusajs/medusa/fulfillment-manual", id: "manual" }],
+      },
+    },
+    file: {
+      resolve: "@medusajs/medusa/file",
+      options: {
+        providers: [
+          {
+            resolve: "@medusajs/medusa/file-local",
+            id: "local",
+            options: {
+              upload_dir: "static",
+              backend_url: `${process.env.MEDUSA_BACKEND_URL || "http://localhost:9000"}/static`,
+            },
+          },
+        ],
+      },
+    },
+  },
+})

package/templates/backend/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/templates/backend/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/templates/backend/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" },
+]