@akinon/next 2.0.6-rc.1 → 2.0.6

package/utils/payload-optimizer.ts

@@ -1,481 +0,0 @@
-import { GetCategoryResponse } from '../types/commerce/category'
-import { Product, ProductResult } from '../types/commerce/product'
-
-/**
- * Payload Optimization Config
- *
- * - Optimizer returns minimum fields needed for the base project.
- * - Projects extend via "Extra" arrays in settings.js.
- * - Each config array works as "base + extra".
- *
- * Example:
- * ```js
- * payloadOptimization: {
- *   enabled: true,
- *   listProductImageLimit: 1,
- *   listProductExtraFields: ['stock', 'tax_rate'],
- *   listProductExtraAttributes: ['my_custom_attr'],
- *   listProductExtraAttributesKwargs: ['integration_renk'],
- * }
- * ```
- */
-export interface PayloadOptimizationConfig {
-  enabled: boolean
-
-  // ── Image Limits ───────────────────────────────────────────────────────────
-  /** Max images per product on list pages (default: 3) */
-  listProductImageLimit?: number
-  /** Extra hover image count after the limit (default: 2) */
-  listHoverImageCount?: number
-  /** Max images per product in widgets (default: listProductImageLimit) */
-  widgetProductImageLimit?: number
-  /** Widget hover image count (default: listHoverImageCount) */
-  widgetHoverImageCount?: number
-  /** Max images per variant product on PDP (default: 1) */
-  pdpVariantImageLimit?: number
-
-  // ── List / Category / Special Page ─────────────────────────────────────────
-  /** Extra top-level product fields on top of base */
-  listProductExtraFields?: string[]
-  /** Extra keys from product.attributes on top of base */
-  listProductExtraAttributes?: string[]
-  /** Extra keys from product.attributes_kwargs on top of base */
-  listProductExtraAttributesKwargs?: string[]
-  /** Extra keys from product.extra_attributes on top of base */
-  listProductExtraExtraAttributes?: string[]
-  /** Extra keys from product.data_source on top of base */
-  listDataSourceExtraFields?: string[]
-
-  // ── Product Detail Page ────────────────────────────────────────────────────
-  /** Extra keys from product.attributes on top of base */
-  pdpProductExtraAttributes?: string[]
-  /** Extra keys from product.attributes_kwargs on top of base */
-  pdpProductExtraAttributesKwargs?: string[]
-  /** Extra keys from product.extra_attributes on top of base */
-  pdpProductExtraExtraAttributes?: string[]
-  /** Extra keys from variant product.attributes on top of base */
-  pdpVariantExtraAttributes?: string[]
-  /** Extra keys from variant product.attributes_kwargs on top of base */
-  pdpVariantExtraAttributesKwargs?: string[]
-  /** Extra keys from product.data_source on top of base */
-  pdpDataSourceExtraFields?: string[]
-  /** Extra top-level product fields on top of base */
-  pdpProductExtraFields?: string[]
-
-  // ── Category ───────────────────────────────────────────────────────────────
-  /** Extra top-level category fields on top of base */
-  categoryExtraFields?: string[]
-  /** Extra keys from category.attributes on top of base */
-  categoryExtraAttributes?: string[]
-
-  // ── Special Page ───────────────────────────────────────────────────────────
-  /** Extra fields from special_page on top of base */
-  specialPageExtraFields?: string[]
-
-  // ── Offers ─────────────────────────────────────────────────────────────────
-  /** Extra keys from offer.listing_kwargs on top of base */
-  offerExtraListingKwargsFields?: string[]
-}
-
-// ─── Base Field Sets ─────────────────────────────────────────────────────────
-// Minimum fields required by the base project (projectzeronext).
-// Projects extend these via "Extra" arrays in settings.js.
-
-const BASE_LIST_PRODUCT_FIELDS = [
-  'pk', 'name', 'base_code', 'absolute_url',
-  'price', 'retail_price', 'in_stock'
-]
-
-const BASE_LIST_PRODUCT_ATTRIBUTES: string[] = []
-const BASE_LIST_PRODUCT_ATTRIBUTES_KWARGS: string[] = []
-const BASE_LIST_PRODUCT_EXTRA_ATTRIBUTES: string[] = []
-const BASE_LIST_DATASOURCE_FIELDS = ['pk', 'name']
-
-const BASE_PDP_PRODUCT_FIELDS = [
-  'pk', 'name', 'sku', 'base_code', 'price', 'retail_price',
-  'in_stock', 'product_type', 'currency_type', 'absolute_url',
-  'productimage_set', 'attribute_set', 'unit_type', 'tax_rate',
-  'stock', 'price_type', 'form_schema', 'is_ready_to_basket',
-  'data_source', 'basket_offers', 'data_source_offers',
-  'is_listable', 'listing_code', 'price_extra_field'
-]
-
-const BASE_PDP_PRODUCT_ATTRIBUTES = [
-  'integration_ProductAtt03Desc', 'integration_kumas_icerik',
-  'model_olculeri', 'aciklama'
-]
-
-const BASE_PDP_PRODUCT_ATTRIBUTES_KWARGS: string[] = []
-const BASE_PDP_PRODUCT_EXTRA_ATTRIBUTES: string[] = []
-
-const BASE_PDP_DATASOURCE_FIELDS = [
-  'pk', 'name', 'title', 'phone_number', 'address',
-  'mersis_number', 'kep_address'
-]
-
-const BASE_PDP_VARIANT_ATTRIBUTES: string[] = []
-const BASE_PDP_VARIANT_ATTRIBUTES_KWARGS: string[] = []
-
-const BASE_CATEGORY_FIELDS = [
-  'pk', 'name', 'menuitemmodel', 'absolute_url', 'sort_option'
-]
-
-const BASE_CATEGORY_ATTRIBUTES: string[] = []
-
-const BASE_SPECIAL_PAGE_FIELDS = ['pk', 'name', 'url', 'banner_url']
-
-const DEFAULT_LIST_IMAGE_LIMIT = 3
-const DEFAULT_PDP_VARIANT_IMAGE_LIMIT = 1
-
-// ─── Helpers ─────────────────────────────────────────────────────────────────
-
-function merge(base: string[], extra?: string[]): string[] {
-  if (!extra?.length) return base
-  return [...base, ...extra]
-}
-
-function pickKeys(obj: any, keys: string[]): any {
-  if (!obj) return undefined
-  const result: any = {}
-  for (const key of keys) {
-    if (obj[key] != null) {
-      result[key] = obj[key]
-    }
-  }
-  return result
-}
-
-function pickAttributesKwargs(kwargs: any, keys: string[]): any {
-  if (!kwargs) return undefined
-  const result: any = {}
-  for (const key of keys) {
-    if (kwargs[key] != null) {
-      result[key] = kwargs[key]?.label != null
-        ? { label: kwargs[key].label }
-        : kwargs[key]
-    }
-  }
-  return result
-}
-
-function stripImages(images: any[] | undefined, limit: number) {
-  if (!images?.length) return undefined
-  return images.slice(0, limit).map((img: any) => ({ image: img.image }))
-}
-
-function stripOffer(offer: any, extraFields?: string[]) {
-  if (!offer) return offer
-  const lk: any = offer.listing_kwargs
-    ? { discounted_total_price: offer.listing_kwargs.discounted_total_price, quantity: offer.listing_kwargs.quantity }
-    : undefined
-
-  if (lk && extraFields && offer.listing_kwargs) {
-    for (const f of extraFields) {
-      if (offer.listing_kwargs[f] !== undefined) lk[f] = offer.listing_kwargs[f]
-    }
-  }
-
-  return {
-    pk: offer.pk,
-    label: offer.label,
-    listing_kwargs: lk,
-    kwargs: offer.kwargs,
-    data_source: offer.data_source ? { pk: offer.data_source.pk } : undefined
-  }
-}
-
-function applyOffers(target: any, source: any, config: PayloadOptimizationConfig) {
-  const extra = config.offerExtraListingKwargsFields
-  if (source.basket_offers) {
-    target.basket_offers = source.basket_offers.map((o: any) => stripOffer(o, extra))
-  }
-  if (source.data_source_offers) {
-    target.data_source_offers = source.data_source_offers.map(
-      (g: any) => Array.isArray(g) ? g.map((o: any) => stripOffer(o, extra)) : stripOffer(g, extra)
-    )
-  }
-}
-
-function stripFacet(facet: any) {
-  if (!facet) return facet
-  return {
-    key: facet.key,
-    name: facet.name,
-    search_key: facet.search_key,
-    widget_type: facet.widget_type,
-    data: facet.data ? {
-      choices: facet.data.choices?.map((c: any) => ({
-        label: c.label, value: c.value, quantity: c.quantity,
-        selected: c.selected, is_selected: c.is_selected,
-        children: c.children
-      })),
-      key: facet.data.key, name: facet.data.name, order: facet.data.order,
-      search_key: facet.data.search_key, widget_type: facet.data.widget_type
-    } : undefined
-  }
-}
-
-// ─── Precomputed Key Sets ────────────────────────────────────────────────────
-// Computed once per config to avoid repeated merge() calls per product.
-
-interface ListKeySet {
-  fields: string[]
-  attrKeys: string[]
-  kwargsKeys: string[]
-  extraAttrKeys: string[]
-  dsFields: string[]
-  imageLimit: number
-  hoverCount: number
-}
-
-function buildListKeySet(config: PayloadOptimizationConfig): ListKeySet {
-  return {
-    fields: merge(BASE_LIST_PRODUCT_FIELDS, config.listProductExtraFields),
-    attrKeys: merge(BASE_LIST_PRODUCT_ATTRIBUTES, config.listProductExtraAttributes),
-    kwargsKeys: merge(BASE_LIST_PRODUCT_ATTRIBUTES_KWARGS, config.listProductExtraAttributesKwargs),
-    extraAttrKeys: merge(BASE_LIST_PRODUCT_EXTRA_ATTRIBUTES, config.listProductExtraExtraAttributes),
-    dsFields: merge(BASE_LIST_DATASOURCE_FIELDS, config.listDataSourceExtraFields),
-    imageLimit: config.listProductImageLimit ?? DEFAULT_LIST_IMAGE_LIMIT,
-    hoverCount: config.listHoverImageCount ?? 2
-  }
-}
-
-function buildWidgetKeySet(config: PayloadOptimizationConfig): ListKeySet {
-  const listKeys = buildListKeySet(config)
-  return {
-    ...listKeys,
-    imageLimit: config.widgetProductImageLimit ?? listKeys.imageLimit,
-    hoverCount: config.widgetHoverImageCount ?? listKeys.hoverCount
-  }
-}
-
-// ─── Shared Product Stripping ────────────────────────────────────────────────
-
-function stripProduct(
-  product: any,
-  keys: ListKeySet,
-  config: PayloadOptimizationConfig,
-  opts?: { includeHoverImages?: boolean, includeWidgetVariants?: boolean }
-): any {
-  if (!product) return product
-
-  const allImages = product.productimage_set ?? []
-  const stripped: any = pickKeys(product, keys.fields)
-
-  stripped.productimage_set = stripImages(allImages, keys.imageLimit)
-
-  if (opts?.includeHoverImages && keys.hoverCount > 0 && allImages.length > keys.imageLimit) {
-    stripped._hoverImageUrls = allImages
-      .slice(keys.imageLimit, keys.imageLimit + keys.hoverCount)
-      .map((img: any) => img.image)
-  }
-
-  stripped.attributes = pickKeys(product.attributes, keys.attrKeys)
-  stripped.attributes_kwargs = pickAttributesKwargs(product.attributes_kwargs, keys.kwargsKeys)
-  stripped.extra_attributes = pickKeys(product.extra_attributes, keys.extraAttrKeys)
-
-  if (product.data_source) {
-    stripped.data_source = pickKeys(product.data_source, keys.dsFields)
-  }
-
-  applyOffers(stripped, product, config)
-
-  // Widget variants: strip to minimal
-  if (opts?.includeWidgetVariants && product.extra_data?.variants) {
-    stripped.extra_data = {
-      variants: product.extra_data.variants.map((variant: any) => ({
-        attribute_key: variant.attribute_key,
-        options: variant.options?.map((option: any) => {
-          if (!option.product) return option
-          const op = option.product
-          return {
-            ...option,
-            product: {
-              pk: op.pk,
-              absolute_url: op.absolute_url,
-              price: op.price,
-              retail_price: op.retail_price,
-              stock: op.stock,
-              in_stock: op.in_stock != null ? op.in_stock : (op.stock ?? 0) > 0,
-              productimage_set: stripImages(op.productimage_set, 1),
-              attributes: pickKeys(op.attributes, keys.attrKeys),
-              price_extra_field: op.price_extra_field
-            }
-          }
-        })
-      }))
-    }
-  }
-
-  return stripped
-}
-
-// ─── List / Category / Special Page ──────────────────────────────────────────
-
-export function optimizeCategoryResponse(data: GetCategoryResponse, config: PayloadOptimizationConfig): GetCategoryResponse {
-  if (!data) return data
-
-  // Shallow copy to avoid mutating cached data
-  const result = { ...data }
-  const keys = buildListKeySet(config)
-
-  if (result.products?.length) {
-    result.products = result.products.map(
-      (p) => stripProduct(p, keys, config, { includeHoverImages: true }) as Product
-    )
-  }
-
-  if (result.facets?.length) {
-    result.facets = result.facets.map((f) => stripFacet(f) as typeof f)
-  }
-
-  if (result.category) {
-    const cat = result.category as any
-    const catFields = merge(BASE_CATEGORY_FIELDS, config.categoryExtraFields)
-    const strippedCat: any = pickKeys(cat, catFields)
-    strippedCat.attributes = config.categoryExtraAttributes?.length
-      ? pickKeys(cat.attributes, merge(BASE_CATEGORY_ATTRIBUTES, config.categoryExtraAttributes))
-      : cat.attributes
-    result.category = strippedCat
-  }
-
-  if ((result as any).special_page) {
-    const spFields = merge(BASE_SPECIAL_PAGE_FIELDS, config.specialPageExtraFields)
-    ;(result as any).special_page = pickKeys((result as any).special_page, spFields)
-  }
-
-  return result
-}
-
-// ─── Product Detail Page ─────────────────────────────────────────────────────
-
-export function optimizeProductResponse(data: ProductResult, config: PayloadOptimizationConfig): ProductResult {
-  if (!data) return data
-
-  // Shallow copy to avoid mutating cached data
-  const result = { ...data } as any
-  const variantImageLimit = config.pdpVariantImageLimit ?? DEFAULT_PDP_VARIANT_IMAGE_LIMIT
-
-  // Precompute key sets once
-  const pdpFields = merge(BASE_PDP_PRODUCT_FIELDS, config.pdpProductExtraFields)
-  const attrKeys = merge(BASE_PDP_PRODUCT_ATTRIBUTES, config.pdpProductExtraAttributes)
-  const kwargsKeys = merge(BASE_PDP_PRODUCT_ATTRIBUTES_KWARGS, config.pdpProductExtraAttributesKwargs)
-  const extraAttrKeys = merge(BASE_PDP_PRODUCT_EXTRA_ATTRIBUTES, config.pdpProductExtraExtraAttributes)
-  const dsFields = merge(BASE_PDP_DATASOURCE_FIELDS, config.pdpDataSourceExtraFields)
-  const varAttrKeys = merge(BASE_PDP_VARIANT_ATTRIBUTES, config.pdpVariantExtraAttributes)
-  const varKwargsKeys = config.pdpVariantExtraAttributesKwargs?.length
-    ? merge(BASE_PDP_VARIANT_ATTRIBUTES_KWARGS, config.pdpVariantExtraAttributesKwargs)
-    : undefined
-
-  if (data.product) {
-    const p = data.product as any
-    const stripped: any = pickKeys(p, pdpFields)
-
-    // Strip specialimage_set from images
-    if (stripped.productimage_set) {
-      stripped.productimage_set = stripped.productimage_set.map((img: any) => ({
-        pk: img.pk, image: img.image, order: img.order, status: img.status
-      }))
-    }
-
-    stripped.attributes = pickKeys(p.attributes, attrKeys)
-    stripped.attributes_kwargs = pickKeys(p.attributes_kwargs, kwargsKeys)
-    stripped.extra_attributes = pickKeys(p.extra_attributes, extraAttrKeys)
-
-    if (p.data_source) {
-      stripped.data_source = pickKeys(p.data_source, dsFields)
-    }
-
-    applyOffers(stripped, p, config)
-    result.product = stripped
-  }
-
-  if (result.offers) {
-    result.offers = result.offers.map((offer: any) => ({
-      pk: offer.pk,
-      name: offer.name,
-      in_stock: offer.in_stock,
-      price: offer.price,
-      retail_price: offer.retail_price,
-      absolute_url: offer.absolute_url,
-      attributes: pickKeys(offer.attributes, attrKeys),
-      attributes_kwargs: pickKeys(offer.attributes_kwargs, kwargsKeys),
-      extra_attributes: pickKeys(offer.extra_attributes, extraAttrKeys),
-      data_source: offer.data_source ? pickKeys(offer.data_source, dsFields) : undefined
-    }))
-  }
-
-  if (data.variants) {
-    result.variants = data.variants.map((variant: any) => ({
-      ...variant,
-      options: variant.options?.map((option: any) => {
-        if (!option.product) return option
-        const op = option.product
-        return {
-          ...option,
-          product: {
-            pk: op.pk,
-            sku: op.sku,
-            name: op.name,
-            in_stock: op.in_stock,
-            stock: op.stock,
-            price: op.price,
-            retail_price: op.retail_price,
-            absolute_url: op.absolute_url,
-            productimage_set: op.productimage_set?.slice(0, variantImageLimit),
-            price_extra_field: op.price_extra_field,
-            attributes: pickKeys(op.attributes, varAttrKeys),
-            attributes_kwargs: varKwargsKeys ? pickKeys(op.attributes_kwargs, varKwargsKeys) : op.attributes_kwargs
-          }
-        }
-      })
-    }))
-  }
-
-  if (data.group_products) {
-    result.group_products = data.group_products.map((gp: any) => ({
-      pk: gp.pk, name: gp.name, sku: gp.sku,
-      in_stock: gp.in_stock, price: gp.price, retail_price: gp.retail_price,
-      productimage_set: gp.productimage_set
-    }))
-  }
-
-  return result as ProductResult
-}
-
-// ─── Widget ──────────────────────────────────────────────────────────────────
-
-export function optimizeWidgetResponse(data: any, config: PayloadOptimizationConfig): any {
-  if (!data) return data
-
-  const result = { ...data }
-  const keys = buildWidgetKeySet(config)
-
-  if (result.products?.length && result.products[0]?.pk) {
-    result.products = result.products.map(
-      (p: any) => stripProduct(p, keys, config, { includeHoverImages: true, includeWidgetVariants: true })
-    )
-  }
-
-  if (result.attributes) {
-    result.attributes = { ...result.attributes }
-    for (const key of Object.keys(result.attributes)) {
-      const val = result.attributes[key]
-      if (Array.isArray(val) && val.length > 0 && val[0]?.pk && val[0]?.productimage_set) {
-        result.attributes[key] = val.map(
-          (p: any) => stripProduct(p, keys, config, { includeHoverImages: true, includeWidgetVariants: true })
-        )
-      }
-      if (val?.value && Array.isArray(val.value) && val.value.length > 0 && val.value[0]?.pk && val.value[0]?.productimage_set) {
-        result.attributes[key] = {
-          ...val,
-          value: val.value.map(
-            (p: any) => stripProduct(p, keys, config, { includeHoverImages: true, includeWidgetVariants: true })
-          )
-        }
-      }
-    }
-  }
-
-  return result
-}