@labdigital/commercetools-mock 0.9.1 → 0.10.1

package/src/repositories/cart.ts

@@ -18,23 +18,22 @@ import {
   Product,
   ProductPagedQueryResponse,
   ProductVariant,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
 import { v4 as uuidv4 } from 'uuid'
+import { CommercetoolsError } from '../exceptions'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import { createCustomFields } from './helpers'
-import { Writable } from '../types'
-import { CommercetoolsError } from '../exceptions'
 
-export class CartRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'cart'
+export class CartRepository extends AbstractResourceRepository<'cart'> {
+  getTypeId() {
+    return 'cart' as const
   }
 
   create(context: RepositoryContext, draft: CartDraft): Cart {
     const lineItems =
-      draft.lineItems?.map(draftLineItem =>
+      draft.lineItems?.map((draftLineItem) =>
         this.draftLineItemtoLineItem(
           context.projectKey,
           draftLineItem,
@@ -43,35 +42,35 @@ export class CartRepository extends AbstractResourceRepository {
         )
       ) ?? []
 
-    const resource: Cart = {
+    const resource: Writable<Cart> = {
       ...getBaseResourceProperties(),
       cartState: 'Active',
-      lineItems,
+      country: draft.country,
       customLineItems: [],
+      lineItems,
+      locale: draft.locale,
+      taxCalculationMode: draft.taxCalculationMode ?? 'LineItemLevel',
+      taxMode: draft.taxMode ?? 'Platform',
+      taxRoundingMode: draft.taxRoundingMode ?? 'HalfEven',
       totalPrice: {
         type: 'centPrecision',
         centAmount: 0,
         currencyCode: draft.currency,
         fractionDigits: 0,
       },
-      taxMode: draft.taxMode ?? 'Platform',
-      taxRoundingMode: draft.taxRoundingMode ?? 'HalfEven',
-      taxCalculationMode: draft.taxCalculationMode ?? 'LineItemLevel',
-      refusedGifts: [],
-      locale: draft.locale,
-      country: draft.country,
+      shippingMode: 'Single',
+      shipping: [],
       origin: draft.origin ?? 'Customer',
+      refusedGifts: [],
       custom: createCustomFields(
         draft.custom,
         context.projectKey,
         this._storage
       ),
     }
-
-    // @ts-ignore
     resource.totalPrice.centAmount = calculateCartTotalPrice(resource)
 
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 
@@ -94,7 +93,6 @@ export class CartRepository extends AbstractResourceRepository {
       { productId, variantId, sku, quantity = 1 }: CartAddLineItemAction
     ) => {
       let product: Product | null = null
-      let variant: ProductVariant | undefined
 
       if (productId && variantId) {
         // Fetch product and variant by ID
@@ -128,10 +126,10 @@ export class CartRepository extends AbstractResourceRepository {
       }
 
       // Find matching variant
-      variant = [
+      const variant: ProductVariant | undefined = [
         product.masterData.current.masterVariant,
         ...product.masterData.current.variants,
-      ].find(x => {
+      ].find((x) => {
         if (sku) return x.sku === sku
         if (variantId) return x.id === variantId
         return false
@@ -148,11 +146,11 @@ export class CartRepository extends AbstractResourceRepository {
       }
 
       const alreadyAdded = resource.lineItems.some(
-        x => x.productId === product?.id && x.variant.id === variant?.id
+        (x) => x.productId === product?.id && x.variant.id === variant?.id
       )
       if (alreadyAdded) {
         // increase quantity and update total price
-        resource.lineItems.map(x => {
+        resource.lineItems.map((x) => {
           if (x.productId === product?.id && x.variant.id === variant?.id) {
             x.quantity += quantity
             x.totalPrice.centAmount = calculateLineItemTotalPrice(x)
@@ -184,11 +182,13 @@ export class CartRepository extends AbstractResourceRepository {
           id: uuidv4(),
           productId: product.id,
           productKey: product.key,
-          name: product.masterData.current.name,
           productSlug: product.masterData.current.slug,
           productType: product.productType,
+          name: product.masterData.current.name,
           variant,
           price: price,
+          taxedPricePortions: [],
+          perMethodTaxRate: [],
           totalPrice: {
             ...price.value,
             centAmount: price.value.centAmount * quantity,
@@ -209,7 +209,7 @@ export class CartRepository extends AbstractResourceRepository {
       resource: Writable<Cart>,
       { lineItemId, quantity }: CartRemoveLineItemAction
     ) => {
-      const lineItem = resource.lineItems.find(x => x.id === lineItemId)
+      const lineItem = resource.lineItems.find((x) => x.id === lineItemId)
       if (!lineItem) {
         // Check if product is found
         throw new CommercetoolsError<GeneralError>({
@@ -221,10 +221,12 @@ export class CartRepository extends AbstractResourceRepository {
       const shouldDelete = !quantity || quantity >= lineItem.quantity
       if (shouldDelete) {
         // delete line item
-        resource.lineItems = resource.lineItems.filter(x => x.id !== lineItemId)
+        resource.lineItems = resource.lineItems.filter(
+          (x) => x.id !== lineItemId
+        )
       } else {
         // decrease quantity and update total price
-        resource.lineItems.map(x => {
+        resource.lineItems.map((x) => {
           if (x.id === lineItemId && quantity) {
             x.quantity -= quantity
             x.totalPrice.centAmount = calculateLineItemTotalPrice(x)
@@ -248,21 +250,28 @@ export class CartRepository extends AbstractResourceRepository {
       resource: Writable<Cart>,
       { shippingMethod }: CartSetShippingMethodAction
     ) => {
-      const resolvedType = this._storage.getByResourceIdentifier(
-        context.projectKey,
-        //@ts-ignore
-        shippingMethod
-      )
+      if (shippingMethod) {
+        const method = this._storage.getByResourceIdentifier<'shipping-method'>(
+          context.projectKey,
+          shippingMethod
+        )
 
-      if (!resolvedType) {
-        throw new Error(`Type ${shippingMethod} not found`)
-      }
-      //@ts-ignore
-      resource.shippingInfo = {
-        shippingMethod: {
-          typeId: 'shipping-method',
-          id: resolvedType.id,
-        },
+        if (!method) {
+          throw new Error(`Type ${shippingMethod} not found`)
+        }
+
+        // Based on the address we should select a shipping zone and
+        // use that to define the price.
+        // @ts-ignore
+        resource.shippingInfo = {
+          shippingMethod: {
+            typeId: 'shipping-method',
+            id: method.id,
+          },
+          shippingMethodName: method.name,
+        }
+      } else {
+        resource.shippingInfo = undefined
       }
     },
     setCountry: (
@@ -338,7 +347,6 @@ export class CartRepository extends AbstractResourceRepository {
     const { productId, quantity, variantId, sku } = draftLineItem
 
     let product: Product | null = null
-    let variant: ProductVariant | undefined
 
     if (productId && variantId) {
       // Fetch product and variant by ID
@@ -367,10 +375,10 @@ export class CartRepository extends AbstractResourceRepository {
     }
 
     // Find matching variant
-    variant = [
+    const variant = [
       product.masterData.current.masterVariant,
       ...product.masterData.current.variants,
-    ].find(x => {
+    ].find((x) => {
       if (sku) return x.sku === sku
       if (variantId) return x.id === variantId
       return false
@@ -398,15 +406,17 @@ export class CartRepository extends AbstractResourceRepository {
       id: uuidv4(),
       productId: product.id,
       productKey: product.key,
-      name: product.masterData.current.name,
       productSlug: product.masterData.current.slug,
       productType: product.productType,
+      name: product.masterData.current.name,
       variant,
       price: price,
       totalPrice: {
         ...price.value,
         centAmount: price.value.centAmount * quant,
       },
+      taxedPricePortions: [],
+      perMethodTaxRate: [],
       quantity: quant,
       discountedPricePerQuantity: [],
       lineItemMode: 'Standard',
@@ -432,7 +442,7 @@ const selectPrice = ({
   // 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 => {
+  return prices.find((price) => {
     const countryMatch = !price.country || price.country === country
     const currencyMatch = price.value.currencyCode === currency
     return countryMatch && currencyMatch

package/src/repositories/category.ts

@@ -1,4 +1,3 @@
-import { v4 as uuidv4 } from 'uuid'
 import {
   Category,
   CategoryChangeAssetNameAction,
@@ -13,16 +12,16 @@ import {
   CategorySetMetaDescriptionAction,
   CategorySetMetaKeywordsAction,
   CategorySetMetaTitleAction,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
-import { Writable } from 'types'
+import { v4 as uuidv4 } from 'uuid'
 import { getBaseResourceProperties } from '../helpers'
-import { createCustomFields } from './helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
+import { createCustomFields } from './helpers'
 
-export class CategoryRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'category'
+export class CategoryRepository extends AbstractResourceRepository<'category'> {
+  getTypeId() {
+    return 'category' as const
   }
 
   create(context: RepositoryContext, draft: CategoryDraft): Category {
@@ -38,28 +37,26 @@ export class CategoryRepository extends AbstractResourceRepository {
         : undefined,
       ancestors: [], // TODO
       assets:
-        draft.assets?.map(d => {
-          return {
-            id: uuidv4(),
-            name: d.name,
-            description: d.description,
-            sources: d.sources,
-            tags: d.tags,
-            key: d.key,
-            custom: createCustomFields(
-              draft.custom,
-              context.projectKey,
-              this._storage
-            ),
-          }
-        }) || [],
+        draft.assets?.map((d) => ({
+          id: uuidv4(),
+          name: d.name,
+          description: d.description,
+          sources: d.sources,
+          tags: d.tags,
+          key: d.key,
+          custom: createCustomFields(
+            draft.custom,
+            context.projectKey,
+            this._storage
+          ),
+        })) || [],
       custom: createCustomFields(
         draft.custom,
         context.projectKey,
         this._storage
       ),
     }
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 
@@ -69,7 +66,7 @@ export class CategoryRepository extends AbstractResourceRepository {
       resource: Writable<Category>,
       { assetId, assetKey, name }: CategoryChangeAssetNameAction
     ) => {
-      resource.assets?.forEach(asset => {
+      resource.assets?.forEach((asset) => {
         if (assetId && assetId === asset.id) {
           asset.name = name
         }
@@ -97,7 +94,7 @@ export class CategoryRepository extends AbstractResourceRepository {
       resource: Writable<Category>,
       { assetId, assetKey, description }: CategorySetAssetDescriptionAction
     ) => {
-      resource.assets?.forEach(asset => {
+      resource.assets?.forEach((asset) => {
         if (assetId && assetId === asset.id) {
           asset.description = description
         }
@@ -111,7 +108,7 @@ export class CategoryRepository extends AbstractResourceRepository {
       resource: Writable<Category>,
       { assetId, assetKey, sources }: CategorySetAssetSourcesAction
     ) => {
-      resource.assets?.forEach(asset => {
+      resource.assets?.forEach((asset) => {
         if (assetId && assetId === asset.id) {
           asset.sources = sources
         }

package/src/repositories/channel.ts

@@ -9,16 +9,15 @@ import {
   ChannelSetCustomTypeAction,
   ChannelSetGeoLocationAction,
   ChannelUpdateAction,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
-import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import { createAddress, createCustomFields } from './helpers'
 
-export class ChannelRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'channel'
+export class ChannelRepository extends AbstractResourceRepository<'channel'> {
+  getTypeId() {
+    return 'channel' as const
   }
 
   create(context: RepositoryContext, draft: ChannelDraft): Channel {
@@ -36,7 +35,7 @@ export class ChannelRepository extends AbstractResourceRepository {
         this._storage
       ),
     }
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 

package/src/repositories/custom-object.ts

@@ -1,16 +1,17 @@
 import {
   CustomObject,
   CustomObjectDraft,
-  ReferenceTypeId,
+  InvalidOperationError,
 } from '@commercetools/platform-sdk'
-import { checkConcurrentModification } from './errors'
-import { AbstractResourceRepository, RepositoryContext } from './abstract'
+import { CommercetoolsError } from '../exceptions'
+import { cloneObject, getBaseResourceProperties } from '../helpers'
 import { Writable } from '../types'
-import { getBaseResourceProperties } from '../helpers'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+import { checkConcurrentModification } from './errors'
 
-export class CustomObjectRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'key-value-document'
+export class CustomObjectRepository extends AbstractResourceRepository<'key-value-document'> {
+  getTypeId() {
+    return 'key-value-document' as const
   }
 
   create(
@@ -21,37 +22,46 @@ export class CustomObjectRepository extends AbstractResourceRepository {
       context,
       draft.container,
       draft.key
-    )
+    ) as Writable<CustomObject | undefined>
 
-    const baseProperties = getBaseResourceProperties()
     if (current) {
-      baseProperties.id = current.id
-
-      if (!draft.version) {
+      // Only check version if it is passed in the draft
+      if (draft.version) {
+        checkConcurrentModification(current.version, draft.version, current.id)
+      } else {
         draft.version = current.version
       }
 
-      checkConcurrentModification(current, draft.version)
-      if (draft.value === current.value) {
-        return current
+      if (draft.value !== current.value) {
+        const updated = cloneObject(current) as Writable<CustomObject>
+        updated.value = draft.value
+        updated.version += 1
+        this.saveUpdate(context, draft.version, updated)
+        return updated
       }
-
-      baseProperties.version = current.version
+      return current
     } else {
+      // If the resource is new the only valid version is 0
       if (draft.version) {
-        baseProperties.version = draft.version
+        throw new CommercetoolsError<InvalidOperationError>(
+          {
+            code: 'InvalidOperation',
+            message: 'version on create must be 0',
+          },
+          400
+        )
+      }
+      const baseProperties = getBaseResourceProperties()
+      const resource: CustomObject = {
+        ...baseProperties,
+        container: draft.container,
+        key: draft.key,
+        value: draft.value,
       }
-    }
 
-    const resource: CustomObject = {
-      ...baseProperties,
-      container: draft.container,
-      key: draft.key,
-      value: draft.value,
+      this.saveNew(context, resource)
+      return resource
     }
-
-    this.save(context, resource)
-    return resource
   }
 
   getWithContainerAndKey(
@@ -59,10 +69,9 @@ export class CustomObjectRepository extends AbstractResourceRepository {
     container: string,
     key: string
   ) {
-    const items = this._storage.all(
-      context.projectKey,
-      this.getTypeId()
-    ) as Array<CustomObject>
-    return items.find(item => item.container === container && item.key === key)
+    const items = this._storage.all(context.projectKey, this.getTypeId())
+    return items.find(
+      (item) => item.container === container && item.key === key
+    )
   }
 }

package/src/repositories/customer-group.ts

@@ -5,16 +5,15 @@ import {
   CustomerGroupSetCustomFieldAction,
   CustomerGroupSetCustomTypeAction,
   CustomerGroupSetKeyAction,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
 import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import { createCustomFields } from './helpers'
 
-export class CustomerGroupRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'customer'
+export class CustomerGroupRepository extends AbstractResourceRepository<'customer-group'> {
+  getTypeId() {
+    return 'customer-group' as const
   }
   create(context: RepositoryContext, draft: CustomerGroupDraft): CustomerGroup {
     const resource: CustomerGroup = {
@@ -27,7 +26,7 @@ export class CustomerGroupRepository extends AbstractResourceRepository {
         this._storage
       ),
     }
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 

package/src/repositories/customer.ts

@@ -2,15 +2,18 @@ import {
   Customer,
   CustomerChangeEmailAction,
   CustomerDraft,
-  ReferenceTypeId,
+  CustomerSetAuthenticationModeAction,
+  InvalidInputError,
+  InvalidJsonInputError,
 } from '@commercetools/platform-sdk'
 import { Writable } from 'types'
+import { CommercetoolsError } from '../exceptions'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 
-export class CustomerRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'customer'
+export class CustomerRepository extends AbstractResourceRepository<'customer'> {
+  getTypeId() {
+    return 'customer' as const
   }
 
   create(context: RepositoryContext, draft: CustomerDraft): Customer {
@@ -23,7 +26,7 @@ export class CustomerRepository extends AbstractResourceRepository {
       isEmailVerified: draft.isEmailVerified || false,
       addresses: [],
     }
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 
@@ -48,5 +51,39 @@ export class CustomerRepository extends AbstractResourceRepository {
     ) => {
       resource.email = email
     },
+    setAuthenticationMode: (
+      _context: RepositoryContext,
+      resource: Writable<Customer>,
+      { authMode, password }: CustomerSetAuthenticationModeAction
+    ) => {
+      if (resource.authenticationMode === authMode) {
+        throw new CommercetoolsError<InvalidInputError>(
+          {
+            code: 'InvalidInput',
+            message: `The customer is already using the '${resource.authenticationMode}' authentication mode.`,
+          },
+          400
+        )
+      }
+      resource.authenticationMode = authMode
+      if (authMode === 'ExternalAuth') {
+        delete resource.password
+        return
+      }
+      if (authMode === 'Password') {
+        resource.password = password
+          ? Buffer.from(password).toString('base64')
+          : undefined
+        return
+      }
+      throw new CommercetoolsError<InvalidJsonInputError>(
+        {
+          code: 'InvalidJsonInput',
+          message: 'Request body does not contain valid JSON.',
+          detailedErrorMessage: `actions -> authMode: Invalid enum value: '${authMode}'. Expected one of: 'Password','ExternalAuth'`,
+        },
+        400
+      )
+    },
   }
 }

package/src/repositories/discount-code.ts

@@ -15,16 +15,15 @@ import {
   DiscountCodeSetValidFromAndUntilAction,
   DiscountCodeSetValidUntilAction,
   DiscountCodeUpdateAction,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
-import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import { createCustomFields } from './helpers'
 
-export class DiscountCodeRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'cart-discount'
+export class DiscountCodeRepository extends AbstractResourceRepository<'discount-code'> {
+  getTypeId() {
+    return 'discount-code' as const
   }
 
   create(context: RepositoryContext, draft: DiscountCodeDraft): DiscountCode {
@@ -54,7 +53,7 @@ export class DiscountCodeRepository extends AbstractResourceRepository {
         this._storage
       ),
     }
-    this.save(context, resource)
+    this.saveNew(context, resource)
     return resource
   }
 

package/src/repositories/errors.ts

@@ -1,24 +1,20 @@
-import {
-  BaseResource,
-  ConcurrentModificationError,
-  Project,
-} from '@commercetools/platform-sdk'
+import { ConcurrentModificationError } from '@commercetools/platform-sdk'
 import { CommercetoolsError } from '../exceptions'
 
 export const checkConcurrentModification = (
-  resource: BaseResource | Project,
-  expectedVersion: number
+  currentVersion: number,
+  expectedVersion: number,
+  identifier: string
 ) => {
-  if (resource.version === expectedVersion) return
-
-  const identifier = (resource as BaseResource).id
-    ? (resource as BaseResource).id
-    : (resource as Project).key
+  if (currentVersion === expectedVersion) return
+  console.error(
+    `Object ${identifier} has a different version than expected. Expected: ${expectedVersion} - Actual: ${currentVersion}.`
+  )
 
   throw new CommercetoolsError<ConcurrentModificationError>(
     {
-      message: `Object ${identifier} has a different version than expected. Expected: ${expectedVersion} - Actual: ${resource.version}.`,
-      currentVersion: resource.version,
+      message: `Object ${identifier} has a different version than expected. Expected: ${expectedVersion} - Actual: ${currentVersion}.`,
+      currentVersion: currentVersion,
       code: 'ConcurrentModification',
     },
     409