@teleporthq/teleport-plugin-next-data-source 0.43.55 → 0.43.57

package/src/transformations/ecommerce-product.ts

@@ -1,4 +1,20 @@
 import type { UIDLEcommerceCategory } from '@teleporthq/teleport-types'
+import { StorefrontTax } from '@teleporthq/teleport-shared'
+
+/**
+ * Everything the product transform needs baked in at export time, beyond the
+ * row itself. An options OBJECT rather than positional parameters: the list has
+ * already grown twice and every caller in the chain has to forward it verbatim.
+ */
+export interface EcommerceProductTransformOptions {
+  /** Category taxonomy — lives only in the UIDL, there is no DB table for it. */
+  categories?: UIDLEcommerceCategory[]
+  /**
+   * Percentage to ADD on top of every stored (NET) price for DISPLAY, or 0.
+   * Resolved by the caller through `StorefrontTax.resolveStorefrontTaxRate`.
+   */
+  storefrontTaxRate?: number
+}
 
 /**
  * Flattens the nested category tree (`ecommerceSettings.categories`, baked at
@@ -47,11 +63,16 @@ const flattenCategoriesById = (
  * that UIDL components expect.
  */
 export const generateEcommerceProductTransformationCode = (
-  categories?: UIDLEcommerceCategory[]
+  options: EcommerceProductTransformOptions = {}
 ): string => {
-  const categoriesByIdJson = JSON.stringify(flattenCategoriesById(categories))
+  const categoriesByIdJson = JSON.stringify(flattenCategoriesById(options.categories))
+  const taxHelperCode = StorefrontTax.generateStorefrontTaxHelperCode(
+    options.storefrontTaxRate ?? 0
+  )
 
   return `
+${taxHelperCode}
+
 // Category taxonomy (id -> {name, slug, translations}), baked in at export
 // time — see flattenCategoriesById in ecommerce-product.ts. Empty when the
 // store has no category taxonomy, or products.category_ids simply resolves
@@ -349,6 +370,32 @@ function buildEcommerceProduct(record, options) {
   var hasInStockCombination = !!(firstVariant && isVariantInStock(firstVariant))
   var defaultVariantId = hasInStockCombination ? firstVariant.id : ''
   var defaultVariantPrice = firstVariant ? formatVariantPrice(firstVariant.price, price) : ''
+  // Gross (tax-inclusive) counterparts of the three price fields the STOREFRONT
+  // renders. \`price\` / \`defaultVariantPrice\` / \`variantsJson\` deliberately stay
+  // NET: the same transform feeds the merchant's admin panel, and every write
+  // path (add-to-cart, checkout, the invoice route) re-reads the raw row and
+  // must keep seeing the price the merchant typed. Only these three are safe to
+  // gross, because nothing writes them back.
+  //
+  // MUST mirror packages/renderer/src/utils/ecommerce-products.ts.
+  var displayPrice = grossMoney(price)
+  var defaultVariantDisplayPrice = firstVariant
+    ? grossMoney(formatVariantPrice(firstVariant.price, price))
+    : ''
+  var variantsDisplay = []
+  for (var dv = 0; dv < variants.length; dv++) {
+    var dvRow = variants[dv]
+    variantsDisplay.push({
+      id: dvRow.id,
+      options: dvRow.options,
+      // A null variant price INHERITS the product price, so gross the RESOLVED
+      // value — otherwise an inheriting combination would fall back to the net
+      // base price in the picker while an overriding one showed gross.
+      price: applyStorefrontTax(dvRow.price == null ? price : dvRow.price),
+      quantity: dvRow.quantity,
+      image_url: dvRow.image_url,
+    })
+  }
   // Can this product be added to the cart at all, before the shopper touches the
   // picker? A STRING, same convention as outOfStock/requiresVariantSelection.
   //
@@ -373,6 +420,7 @@ function buildEcommerceProduct(record, options) {
   // combinations + axes from these JSON strings via getAttribute.
   var variantOptionsJson = safeStringifyJson(variantOptions)
   var variantsJson = safeStringifyJson(variants)
+  var variantsDisplayJson = safeStringifyJson(variantsDisplay)
 
   return {
     id: id,
@@ -418,8 +466,11 @@ function buildEcommerceProduct(record, options) {
     variants: variants,
     variantOptionsJson: variantOptionsJson,
     variantsJson: variantsJson,
+    variantsDisplayJson: variantsDisplayJson,
     defaultVariantId: defaultVariantId,
     defaultVariantPrice: defaultVariantPrice,
+    displayPrice: displayPrice,
+    defaultVariantDisplayPrice: defaultVariantDisplayPrice,
     hasPurchasableVariant: hasPurchasableVariant,
   }
 }

package/src/transformations/index.ts

@@ -1,7 +1,28 @@
-import type { UIDLEcommerceCategory } from '@teleporthq/teleport-types'
+import type { GeneratorOptions } from '@teleporthq/teleport-types'
+import { StorefrontTax } from '@teleporthq/teleport-shared'
 import { generateSharedTransformationCode } from './shared-utils'
 import { generateBlogPostTransformationCode } from './blog-post'
-import { generateEcommerceProductTransformationCode } from './ecommerce-product'
+import {
+  generateEcommerceProductTransformationCode,
+  type EcommerceProductTransformOptions,
+} from './ecommerce-product'
+
+export type { EcommerceProductTransformOptions }
+
+/**
+ * Collects everything the product transform bakes in from the generator
+ * options, in ONE place so every fetcher-emitting call site stays in step.
+ *
+ * `storefrontTaxRate` is what turns a NET catalogue price into the price the
+ * shopper is quoted; `resolveStorefrontTaxRate` returns 0 (a no-op) for
+ * tax-inclusive or untaxed stores.
+ */
+export const buildProductTransformOptions = (
+  options: Pick<GeneratorOptions, 'ecommerceSettings' | 'invoiceSettings'>
+): EcommerceProductTransformOptions => ({
+  categories: options.ecommerceSettings?.categories,
+  storefrontTaxRate: StorefrontTax.resolveStorefrontTaxRate(options.invoiceSettings),
+})
 
 export type TransformationType = 'blog-post' | 'ecommerce-product' | null
 
@@ -51,7 +72,7 @@ export const detectTransformationType = (tableName: string): TransformationType
  */
 export const getTransformationCode = (
   tableName: string,
-  categories?: UIDLEcommerceCategory[]
+  options: EcommerceProductTransformOptions = {}
 ): string => {
   const type = detectTransformationType(tableName)
   if (!type) {
@@ -64,7 +85,7 @@ export const getTransformationCode = (
     case 'blog-post':
       return shared + generateBlogPostTransformationCode()
     case 'ecommerce-product':
-      return shared + generateEcommerceProductTransformationCode(categories)
+      return shared + generateEcommerceProductTransformationCode(options)
     default:
       return ''
   }

package/src/utils.ts

@@ -7,12 +7,12 @@ import {
   UIDLDataSource,
   DataSourceType,
   ChunkType,
-  UIDLEcommerceCategory,
 } from '@teleporthq/teleport-types'
 import * as types from '@babel/types'
 import { ASTUtils } from '@teleporthq/teleport-plugin-common'
 import { StringUtils } from '@teleporthq/teleport-shared'
 import { generateDataSourceFetcherWithCore } from './data-source-fetchers'
+import type { EcommerceProductTransformOptions } from './transformations'
 import { DATA_SOURCE_ISR_REVALIDATE_SECONDS } from './isr'
 
 const VALID_DATA_SOURCE_TYPES: DataSourceType[] = [
@@ -192,7 +192,7 @@ export const extractDataSourceIntoNextAPIFolder = (
   dataSources: Record<string, UIDLDataSource>,
   componentChunk: ChunkDefinition,
   extractedResources: GeneratorOptions['extractedResources'],
-  categories?: UIDLEcommerceCategory[]
+  transformOptions: EcommerceProductTransformOptions = {}
 ) => {
   try {
     // Validate node content structure
@@ -446,7 +446,12 @@ export default dataSourceModule.handler
     // Generate fetcher code for API route (exports just the handler)
     let fetcherCode: string
     try {
-      fetcherCode = generateDataSourceFetcherWithCore(dataSource, tableName || '', true, categories)
+      fetcherCode = generateDataSourceFetcherWithCore(
+        dataSource,
+        tableName || '',
+        true,
+        transformOptions
+      )
     } catch (error) {
       return
     }
@@ -896,7 +901,7 @@ export const extractDataSourceIntoGetStaticProps = (
   dependencies: Record<string, any>,
   dynamicRouteAttr?: string,
   folderPath?: string[],
-  categories?: UIDLEcommerceCategory[]
+  transformOptions: EcommerceProductTransformOptions = {}
 ): { success: boolean; chunk?: any } => {
   try {
     // Validate node content
@@ -1224,7 +1229,7 @@ export const extractDataSourceIntoGetStaticProps = (
         dataSource,
         tableName || '',
         false,
-        categories
+        transformOptions
       )
     } catch (error) {
       // tslint:disable-next-line:no-console