@labdigital/commercetools-mock 0.5.22 → 0.6.1

package/dist/projectAPI.d.ts

@@ -1,3 +1,4 @@
+import { GetParams } from 'repositories/abstract';
 import { AbstractStorage } from './storage';
 import { RepositoryMap, ResourceMap, Services } from './types';
 export declare class ProjectAPI {
@@ -6,6 +7,6 @@ export declare class ProjectAPI {
     private _services;
     constructor(projectKey: string, services: Services, storage: AbstractStorage);
     add<ReferenceTypeId extends keyof ResourceMap>(typeId: ReferenceTypeId | 'custom-object', resource: ResourceMap[ReferenceTypeId]): void;
-    get<ReferenceTypeId extends keyof ResourceMap>(typeId: ReferenceTypeId, id: string): ResourceMap[ReferenceTypeId];
+    get<ReferenceTypeId extends keyof ResourceMap>(typeId: ReferenceTypeId, id: string, params: GetParams): ResourceMap[ReferenceTypeId];
     getRepository<ReferenceTypeId extends keyof RepositoryMap>(typeId: ReferenceTypeId): RepositoryMap[ReferenceTypeId];
 }

package/dist/repositories/cart.d.ts

@@ -1,4 +1,4 @@
-import { Cart, CartAddLineItemAction, CartDraft, CartRemoveLineItemAction, CartSetBillingAddressAction, CartSetCountryAction, CartSetCustomerEmailAction, CartSetCustomFieldAction, CartSetCustomTypeAction, CartSetLocaleAction, CartSetShippingAddressAction, ReferenceTypeId } from '@commercetools/platform-sdk';
+import { Cart, CartAddLineItemAction, CartDraft, CartRemoveLineItemAction, CartSetBillingAddressAction, CartSetCountryAction, CartSetCustomerEmailAction, CartSetCustomFieldAction, CartSetCustomTypeAction, CartSetLocaleAction, CartSetShippingAddressAction, CartSetShippingMethodAction, LineItem, LineItemDraft, ReferenceTypeId } from '@commercetools/platform-sdk';
 import { AbstractResourceRepository } from './abstract';
 import { Writable } from '../types';
 export declare class CartRepository extends AbstractResourceRepository {
@@ -9,6 +9,7 @@ export declare class CartRepository extends AbstractResourceRepository {
         addLineItem: (projectKey: string, resource: Writable<Cart>, { productId, variantId, sku, quantity }: CartAddLineItemAction) => void;
         removeLineItem: (projectKey: string, resource: Writable<Cart>, { lineItemId, quantity }: CartRemoveLineItemAction) => void;
         setBillingAddress: (projectKey: string, resource: Writable<Cart>, { address }: CartSetBillingAddressAction) => void;
+        setShippingMethod: (projectKey: string, resource: Writable<Cart>, { shippingMethod }: CartSetShippingMethodAction) => void;
         setCountry: (projectKey: string, resource: Writable<Cart>, { country }: CartSetCountryAction) => void;
         setCustomerEmail: (projectKey: string, resource: Writable<Cart>, { email }: CartSetCustomerEmailAction) => void;
         setCustomField: (projectKey: string, resource: Cart, { name, value }: CartSetCustomFieldAction) => void;
@@ -16,4 +17,5 @@ export declare class CartRepository extends AbstractResourceRepository {
         setLocale: (projectKey: string, resource: Writable<Cart>, { locale }: CartSetLocaleAction) => void;
         setShippingAddress: (projectKey: string, resource: Writable<Cart>, { address }: CartSetShippingAddressAction) => void;
     };
+    draftLineItemtoLineItem: (projectKey: string, draftLineItem: LineItemDraft, currency: string, country: string | undefined) => LineItem;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.22",
+  "version": "0.6.1",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -30,6 +30,7 @@
   "module": "dist/commercetools--mock.esm.js",
   "devDependencies": {
     "@babel/preset-typescript": "^7.16.7",
+    "@commercetools/platform-sdk": "^2.4.1",
     "@types/basic-auth": "^1.1.3",
     "@types/deep-equal": "^1.0.1",
     "@types/express": "^4.17.13",
@@ -46,7 +47,6 @@
     "typescript": "^4.5.4"
   },
   "dependencies": {
-    "@commercetools/platform-sdk": "2.4.1",
     "ajv": "^8.8.2",
     "ajv-formats": "^2.1.1",
     "basic-auth": "^2.0.1",
@@ -57,5 +57,8 @@
     "perplex": "^0.11.0",
     "pratt": "^0.7.0",
     "supertest": "^6.1.6"
+  },
+  "peerDependencies": {
+    "@commercetools/platform-sdk": "^2.4.1"
   }
 }

package/src/projectAPI.ts

@@ -1,3 +1,4 @@
+import { GetParams } from 'repositories/abstract'
 import { getBaseResourceProperties } from './helpers'
 import { AbstractStorage } from './storage'
 import { RepositoryMap, ResourceMap, Services } from './types'
@@ -39,13 +40,14 @@ export class ProjectAPI {
 
   get<ReferenceTypeId extends keyof ResourceMap>(
     typeId: ReferenceTypeId,
-    id: string
+    id: string,
+    params: GetParams
   ): ResourceMap[ReferenceTypeId] {
     return this._storage.get(
       this.projectKey,
       typeId,
       id,
-      {}
+      params
     ) as ResourceMap[ReferenceTypeId]
   }
 

package/src/repositories/cart.ts

@@ -10,8 +10,11 @@ import {
   CartSetCustomTypeAction,
   CartSetLocaleAction,
   CartSetShippingAddressAction,
+  CartSetShippingMethodAction,
   GeneralError,
   LineItem,
+  LineItemDraft,
+  Price,
   Product,
   ProductPagedQueryResponse,
   ProductVariant,
@@ -30,10 +33,20 @@ export class CartRepository extends AbstractResourceRepository {
   }
 
   create(projectKey: string, draft: CartDraft): Cart {
+    const lineItems =
+      draft.lineItems?.map(draftLineItem =>
+        this.draftLineItemtoLineItem(
+          projectKey,
+          draftLineItem,
+          draft.currency,
+          draft.country
+        )
+      ) ?? []
+
     const resource: Cart = {
       ...getBaseResourceProperties(),
       cartState: 'Active',
-      lineItems: [],
+      lineItems,
       customLineItems: [],
       totalPrice: {
         type: 'centPrecision',
@@ -41,13 +54,19 @@ export class CartRepository extends AbstractResourceRepository {
         currencyCode: draft.currency,
         fractionDigits: 0,
       },
-      taxMode: 'Platform',
-      taxRoundingMode: 'HalfEven',
-      taxCalculationMode: 'LineItemLevel',
+      taxMode: draft.taxMode ?? 'Platform',
+      taxRoundingMode: draft.taxRoundingMode ?? 'HalfEven',
+      taxCalculationMode: draft.taxCalculationMode ?? 'LineItemLevel',
       refusedGifts: [],
-      origin: 'Customer',
+      locale: draft.locale,
+      country: draft.country,
+      origin: draft.origin ?? 'Customer',
       custom: createCustomFields(draft.custom, projectKey, this._storage),
     }
+
+    // @ts-ignore
+    resource.totalPrice.centAmount = calculateCartTotalPrice(resource)
+
     this.save(projectKey, resource)
     return resource
   }
@@ -140,7 +159,18 @@ export class CartRepository extends AbstractResourceRepository {
           })
         }
 
-        const price = variant.prices[0]
+        const currency = resource.totalPrice.currencyCode
+
+        const price = selectPrice({
+          prices: variant.prices,
+          currency,
+          country: resource.country,
+        })
+        if (!price) {
+          throw new Error(
+            `No valid price found for ${productId} for country ${resource.country} and currency ${currency}`
+          )
+        }
         resource.lineItems.push({
           id: uuidv4(),
           productId: product.id,
@@ -204,6 +234,28 @@ export class CartRepository extends AbstractResourceRepository {
     ) => {
       resource.billingAddress = address
     },
+    setShippingMethod: (
+      projectKey: string,
+      resource: Writable<Cart>,
+      { shippingMethod }: CartSetShippingMethodAction
+    ) => {
+      const resolvedType = this._storage.getByResourceIdentifier(
+        projectKey,
+        //@ts-ignore
+        shippingMethod
+      )
+
+      if (!resolvedType) {
+        throw new Error(`Type ${shippingMethod} not found`)
+      }
+      //@ts-ignore
+      resource.shippingInfo = {
+        shippingMethod: {
+          typeId: 'shipping-method',
+          id: resolvedType.id,
+        },
+      }
+    },
     setCountry: (
       projectKey: string,
       resource: Writable<Cart>,
@@ -268,6 +320,114 @@ export class CartRepository extends AbstractResourceRepository {
       resource.shippingAddress = address
     },
   }
+  draftLineItemtoLineItem = (
+    projectKey: string,
+    draftLineItem: LineItemDraft,
+    currency: string,
+    country: string | undefined
+  ): LineItem => {
+    const { productId, quantity, variantId, sku } = draftLineItem
+
+    let product: Product | null = null
+    let variant: ProductVariant | undefined
+
+    if (productId && variantId) {
+      // Fetch product and variant by ID
+      product = this._storage.get(projectKey, 'product', productId, {})
+    } else if (sku) {
+      // Fetch product and variant by SKU
+      const items = this._storage.query(projectKey, 'product', {
+        where: [
+          `masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
+        ],
+      }) as ProductPagedQueryResponse
+
+      if (items.count === 1) {
+        product = items.results[0]
+      }
+    }
+
+    if (!product) {
+      // Check if product is found
+      throw new CommercetoolsError<GeneralError>({
+        code: 'General',
+        message: sku
+          ? `A product containing a variant with SKU '${sku}' not found.`
+          : `A product with ID '${productId}' not found.`,
+      })
+    }
+
+    // Find matching variant
+    variant = [
+      product.masterData.current.masterVariant,
+      ...product.masterData.current.variants,
+    ].find(x => {
+      if (sku) return x.sku === sku
+      if (variantId) return x.id === variantId
+      return false
+    })
+
+    if (!variant) {
+      // Check if variant is found
+      throw new Error(
+        sku
+          ? `A variant with SKU '${sku}' for product '${product.id}' not found.`
+          : `A variant with ID '${variantId}' for product '${product.id}' not found.`
+      )
+    }
+
+    const quant = quantity ?? 1
+
+    const price = selectPrice({ prices: variant.prices, currency, country })
+    if (!price) {
+      throw new Error(
+        `No valid price found for ${productId} for country ${country} and currency ${currency}`
+      )
+    }
+
+    return {
+      id: uuidv4(),
+      productId: product.id,
+      productKey: product.key,
+      name: product.masterData.current.name,
+      productSlug: product.masterData.current.slug,
+      productType: product.productType,
+      variant,
+      price: price,
+      totalPrice: {
+        ...price.value,
+        centAmount: price.value.centAmount * quant,
+      },
+      quantity: quant,
+      discountedPricePerQuantity: [],
+      lineItemMode: 'Standard',
+      priceMode: 'Platform',
+      state: [],
+    }
+  }
+}
+
+const selectPrice = ({
+  prices,
+  currency,
+  country,
+}: {
+  prices: Price[] | undefined
+  currency: string
+  country: string | undefined
+}) => {
+  if (!prices) {
+    return undefined
+  }
+
+  // Quick-and-dirty way of selecting price based on the given currency and country.
+  // Can be improved later to give more priority to exact matches over
+  // 'all country' matches, and include customer groups in the mix as well
+  return prices.find(price => {
+    const countryMatch = !price.country || price.country === country
+    const currencyMatch = price.value.currencyCode === currency
+    return countryMatch && currencyMatch
+  })
 }
 
 const calculateLineItemTotalPrice = (lineItem: LineItem): number =>

package/src/repositories/customer.ts

@@ -17,7 +17,9 @@ export class CustomerRepository extends AbstractResourceRepository {
     const resource: Customer = {
       ...getBaseResourceProperties(),
       email: draft.email,
-      password: Buffer.from(draft.password).toString('base64'),
+      password: draft.password
+        ? Buffer.from(draft.password).toString('base64')
+        : undefined,
       isEmailVerified: draft.isEmailVerified || false,
       addresses: [],
     }

package/src/services/cart.test.ts

@@ -76,9 +76,20 @@ describe('Carts Query', () => {
   })
 })
 
-describe('Order Update Actions', () => {
+describe('Cart Update Actions', () => {
   const ctMock = new CommercetoolsMock()
   let cart: Cart | undefined
+
+  const createCart = async (currency: string) => {
+    let response = await supertest(ctMock.app)
+      .post('/dummy/carts')
+      .send({
+        currency,
+      })
+    expect(response.status).toBe(201)
+    cart = response.body
+  }
+
   const productDraft: ProductDraft = {
     name: {
       'nl-NL': 'test product',
@@ -98,6 +109,14 @@ describe('Order Update Actions', () => {
             fractionDigits: 2,
           } as CentPrecisionMoney,
         },
+        {
+          value: {
+            type: 'centPrecision',
+            currencyCode: 'GBP',
+            centAmount: 18900,
+            fractionDigits: 2,
+          } as CentPrecisionMoney,
+        },
       ],
 
       attributes: [
@@ -135,13 +154,7 @@ describe('Order Update Actions', () => {
   }
 
   beforeEach(async () => {
-    let response = await supertest(ctMock.app)
-      .post('/dummy/carts')
-      .send({
-        currency: 'EUR',
-      })
-    expect(response.status).toBe(201)
-    cart = response.body
+    await createCart('EUR')
   })
 
   afterEach(() => {
@@ -220,6 +233,33 @@ describe('Order Update Actions', () => {
     expect(response.body.totalPrice.centAmount).toEqual(29800)
   })
 
+  test.each([
+    ['EUR', 29800],
+    ['GBP', 37800],
+  ])('addLineItem with price selection', async (currency, total) => {
+    await createCart(currency)
+
+    const product = await supertest(ctMock.app)
+      .post(`/dummy/products`)
+      .send(productDraft)
+      .then(x => x.body)
+
+    assert(cart, 'cart not created')
+    assert(product, 'product not created')
+
+    const response = await supertest(ctMock.app)
+      .post(`/dummy/carts/${cart.id}`)
+      .send({
+        version: 1,
+        actions: [{ action: 'addLineItem', sku: '1337', quantity: 2 }],
+      })
+    expect(response.status).toBe(200)
+    expect(response.body.version).toBe(2)
+    expect(response.body.lineItems).toHaveLength(1)
+    expect(response.body.lineItems[0].price.value.currencyCode).toBe(currency)
+    expect(response.body.totalPrice.centAmount).toEqual(total)
+  })
+
   test('addLineItem unknown product', async () => {
     assert(cart, 'cart not created')
 

package/src/services/cart.ts

@@ -2,7 +2,7 @@ import AbstractService from './abstract'
 import { Router } from 'express'
 import { CartRepository } from '../repositories/cart'
 import { AbstractStorage } from '../storage'
-import { Cart, Order } from '@commercetools/platform-sdk'
+import { Cart, CartDraft, Order } from '@commercetools/platform-sdk'
 import { OrderRepository } from '../repositories/order'
 
 export class CartService extends AbstractService {
@@ -37,11 +37,23 @@ export class CartService extends AbstractService {
         return response.status(400).send()
       }
 
-      const newCart = this.repository.create(request.params.projectKey, {
+      const cartDraft: CartDraft = {
         ...cartOrOrder,
         currency: cartOrOrder.totalPrice.currencyCode,
         discountCodes: [],
-      })
+        lineItems: cartOrOrder.lineItems.map(lineItem => {
+          return {
+            ...lineItem,
+            variantId: lineItem.variant.id,
+            sku: lineItem.variant.sku,
+          }
+        }),
+      }
+
+      const newCart = this.repository.create(
+        request.params.projectKey,
+        cartDraft
+      )
 
       return response.status(200).send(newCart)
     })