docs: add TSDocs for 5ef7953 (#15069)

Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>

Author: shahednasser

packages/core/core-flows/src/product/helpers/normalize-for-export.ts

@@ -6,7 +6,21 @@ import {
 } from "@medusajs/framework/types"
 import { MedusaError, upperCaseFirst } from "@medusajs/framework/utils"
 
-// We want to have one row per variant, so we need to normalize the data
+/**
+ * Normalizes product data for export, creating one row per product variant.
+ * Products without variants will have a single row, while products with variants
+ * will have one row per variant containing both product and variant data.
+ *
+ * @param product - The array of products to normalize for export.
+ * @param regions - Object containing an array of region data used for price formatting.
+ * @returns An array of normalized objects ready for export, with flattened product and variant data.
+ *
+ * @example
+ * const normalizedData = normalizeForExport(
+ *   [productA, productB],
+ *   { regions: [region1, region2] }
+ * )
+ */
 export const normalizeForExport = (
   product: HttpTypes.AdminProduct[],
   { regions }: { regions: RegionTypes.RegionDTO[] }

packages/medusa/src/api/admin/products/query-config.ts

@@ -1,5 +1,8 @@
 import { defaultAdminProductVariantFields } from "../product-variants/query-config"
 
+/**
+ * Product-related entity names for query configuration.
+ */
 export enum Entities {
   product = "product",
   product_option = "product_option",
@@ -8,37 +11,58 @@ export enum Entities {
   price = "price",
 }
 
+/**
+ * Default fields for admin product variants, excluding the product relation.
+ */
 export const defaultAdminProductsVariantFields =
   defaultAdminProductVariantFields.filter((field) => field !== "*product")
 
+/**
+ * Query configuration for retrieving a single product variant.
+ */
 export const retrieveVariantConfig = {
   defaults: defaultAdminProductsVariantFields,
   isList: false,
   entity: Entities.product_variant,
 }
 
+/**
+ * Query configuration for listing product variants.
+ */
 export const listVariantConfig = {
   ...retrieveVariantConfig,
   defaultLimit: 50,
   isList: true,
   entity: Entities.product_variant,
 }
 
+/**
+ * Default fields for admin product options.
+ */
 export const defaultAdminProductsOptionFields = ["id", "title"]
 
+/**
+ * Query configuration for retrieving a single product option.
+ */
 export const retrieveOptionConfig = {
   defaults: defaultAdminProductsOptionFields,
   isList: false,
   entity: Entities.product_option,
 }
 
+/**
+ * Query configuration for listing product options.
+ */
 export const listOptionConfig = {
   ...retrieveOptionConfig,
   defaultLimit: 50,
   isList: true,
   entity: Entities.product_option,
 }
 
+/**
+ * Default fields for admin products, including relations and nested fields.
+ */
 export const defaultAdminProductFields = [
   "id",
   "title",
@@ -79,12 +103,18 @@ export const defaultAdminProductFields = [
   "*sales_channels",
 ]
 
+/**
+ * Query configuration for retrieving a single product.
+ */
 export const retrieveProductQueryConfig = {
   defaults: defaultAdminProductFields,
   isList: false,
   entity: Entities.product,
 }
 
+/**
+ * Query configuration for listing products.
+ */
 export const listProductQueryConfig = {
   ...retrieveProductQueryConfig,
   defaultLimit: 50,