@labdigital/commercetools-mock 0.6.4 → 0.7.1

package/src/priceSelector.ts

@@ -0,0 +1,109 @@
+import {
+  InvalidInputError,
+  Price,
+  Product,
+  ProductVariant,
+} from '@commercetools/platform-sdk'
+import { CommercetoolsError } from './exceptions'
+import { Writable } from './types'
+
+export type PriceSelector = {
+  currency?: string
+  country?: string
+  customerGroup?: string
+  channel?: string
+}
+
+/**
+ * Apply the price selector on all the variants. The price selector is applied
+ * on all the prices per variant and the first match per variant is stored in
+ * the scopedPrice attribute
+ */
+export const applyPriceSelector = (
+  products: Product[],
+  selector: PriceSelector
+) => {
+  validatePriceSelector(selector)
+
+  for (const product of products) {
+    const variants: Writable<ProductVariant>[] = [
+      product.masterData.staged?.masterVariant,
+      ...(product.masterData.staged?.variants || []),
+
+      product.masterData.current?.masterVariant,
+      ...(product.masterData.current?.variants || []),
+    ].filter(x => x != undefined)
+
+    for (const variant of variants) {
+      const scopedPrices =
+        variant.prices?.filter(p => priceSelectorFilter(p, selector)) ?? []
+
+      if (scopedPrices.length > 0) {
+        const price = scopedPrices[0]
+
+        variant.scopedPriceDiscounted = false
+        variant.scopedPrice = {
+          ...price,
+          currentValue: price.value,
+        }
+      }
+    }
+  }
+}
+
+const validatePriceSelector = (selector: PriceSelector) => {
+  if (
+    (selector.country || selector.channel || selector.customerGroup) &&
+    !selector.currency
+  ) {
+    throw new CommercetoolsError<InvalidInputError>(
+      {
+        code: 'InvalidInput',
+        message:
+          'The price selecting parameters country, channel and customerGroup ' +
+          'cannot be used without the currency.',
+      },
+      400
+    )
+  }
+}
+
+/**
+ * Return a boolean to indicate if the price matches the selector. Price
+ * selection requires that if the selector or the price has a specific value
+ * then it should match.
+ */
+export const priceSelectorFilter = (
+  price: Price,
+  selector: PriceSelector
+): boolean => {
+  if (
+    (selector.country || price.country) &&
+    selector.country !== price.country
+  ) {
+    return false
+  }
+
+  if (
+    (selector.currency || price.value.currencyCode) &&
+    selector.currency !== price.value.currencyCode
+  ) {
+    return false
+  }
+
+  if (
+    (selector.channel || price.channel?.id) &&
+    selector.channel !== price.channel?.id
+  ) {
+    return false
+  }
+
+  if (
+    (selector.customerGroup || price.customerGroup?.id) &&
+    selector.customerGroup !== price.customerGroup?.id
+  ) {
+    return false
+  }
+
+  return true
+}

package/src/product-projection-search.ts

@@ -0,0 +1,149 @@
+import {
+  InvalidInputError,
+  ProductProjectionPagedSearchResponse,
+  Product,
+  ProductProjection,
+  QueryParam,
+} from '@commercetools/platform-sdk'
+import { CommercetoolsError } from './exceptions'
+import { parseFilterExpression } from './lib/projectionSearchFilter'
+import { applyPriceSelector } from './priceSelector'
+import { AbstractStorage } from './storage'
+
+export type ProductProjectionSearchParams = {
+  fuzzy?: boolean
+  fuzzyLevel?: number
+  markMatchingVariants?: boolean
+  staged?: boolean
+  filter?: string[]
+  'filter.facets'?: string[]
+  'filter.query'?: string[]
+  facet?: string | string[]
+  sort?: string | string[]
+  limit?: number
+  offset?: number
+  withTotal?: boolean
+  priceCurrency?: string
+  priceCountry?: string
+  priceCustomerGroup?: string
+  priceChannel?: string
+  localeProjection?: string
+  storeProjection?: string
+  expand?: string | string[]
+  [key: string]: QueryParam
+}
+
+export class ProductProjectionSearch {
+  protected _storage: AbstractStorage
+
+  constructor(storage: AbstractStorage) {
+    this._storage = storage
+  }
+
+  search(
+    projectKey: string,
+    params: ProductProjectionSearchParams
+  ): ProductProjectionPagedSearchResponse {
+    // Get a copy of all the products in the storage engine. We need a copy
+    // since we will be modifying the data.
+    let resources = this._storage
+      .all(projectKey, 'product')
+      .map(r => JSON.parse(JSON.stringify(r)))
+
+    let markMatchingVariant = params.markMatchingVariants ?? false
+
+    // Apply the priceSelector
+    applyPriceSelector(resources, {
+      country: params.priceCountry,
+      channel: params.priceChannel,
+      customerGroup: params.priceCustomerGroup,
+      currency: params.priceCurrency,
+    })
+
+    // Apply filters pre facetting
+    if (params.filter) {
+      try {
+        const filters = params.filter.map(f =>
+          parseFilterExpression(f, params.staged ?? false)
+        )
+
+        // Filters can modify the output. So clone the resources first.
+        resources = resources
+          .filter(resource =>
+            filters.every(f => f(resource, markMatchingVariant))
+          )
+      } catch (err) {
+        throw new CommercetoolsError<InvalidInputError>(
+          {
+            code: 'InvalidInput',
+            message: (err as any).message,
+          },
+          400
+        )
+      }
+    }
+
+    // TODO: Calculate facets
+
+    // Apply filters post facetting
+    if (params['filter.query']) {
+      try {
+        const filters = params['filter.query'].map(f =>
+          parseFilterExpression(f, params.staged ?? false)
+        )
+        resources = resources
+          .filter(resource =>
+            filters.every(f => f(resource, markMatchingVariant))
+          )
+      } catch (err) {
+        throw new CommercetoolsError<InvalidInputError>(
+          {
+            code: 'InvalidInput',
+            message: (err as any).message,
+          },
+          400
+        )
+      }
+    }
+
+    // Get the total before slicing the array
+    const totalResources = resources.length
+
+    // Apply offset, limit
+    const offset = params.offset || 0
+    const limit = params.limit || 20
+    resources = resources.slice(offset, offset + limit)
+
+    // Expand the resources
+    if (params.expand !== undefined) {
+      resources = resources.map(resource => {
+        return this._storage.expand(projectKey, resource, params.expand)
+      })
+    }
+
+    return {
+      count: totalResources,
+      total: resources.length,
+      offset: offset,
+      limit: limit,
+      results: resources.map(this.transform),
+      facets: {},
+    }
+  }
+
+  transform(product: Product): ProductProjection {
+    const obj = product.masterData.current
+    return {
+      id: product.id,
+      createdAt: product.createdAt,
+      lastModifiedAt: product.lastModifiedAt,
+      version: product.version,
+      name: obj.name,
+      slug: obj.slug,
+      categories: obj.categories,
+      masterVariant: obj.masterVariant,
+      variants: obj.variants,
+      productType: product.productType,
+    }
+  }
+}

package/src/projectAPI.ts

@@ -1,7 +1,14 @@
+import { ReferenceTypeId } from '@commercetools/platform-sdk'
 import { GetParams } from 'repositories/abstract'
 import { getBaseResourceProperties } from './helpers'
 import { AbstractStorage } from './storage'
-import { RepositoryMap, ResourceMap, Services } from './types'
+import {
+  RepositoryMap,
+  RepositoryTypes,
+  ResourceMap,
+  Services,
+  ServiceTypes,
+} from './types'
 
 export class ProjectAPI {
   private projectKey: string
@@ -18,18 +25,10 @@ export class ProjectAPI {
     this._services = services
   }
 
-  add<ReferenceTypeId extends keyof ResourceMap>(
-    typeId: ReferenceTypeId | 'custom-object',
-    resource: ResourceMap[ReferenceTypeId]
-  ) {
-    //@ts-ignore
-    if (typeId === 'custom-object') typeId = 'key-value-document'
-
-    const parsedTypeId = typeId as ReferenceTypeId
-
-    const service = this._services[parsedTypeId]
+  add(typeId: ReferenceTypeId, resource: ResourceMap[ReferenceTypeId]) {
+    const service = this._services[typeId]
     if (service) {
-      this._storage.add(this.projectKey, parsedTypeId, {
+      this._storage.add(this.projectKey, typeId as ReferenceTypeId, {
         ...getBaseResourceProperties(),
         ...resource,
       })
@@ -38,26 +37,26 @@ export class ProjectAPI {
     }
   }
 
-  get<ReferenceTypeId extends keyof ResourceMap>(
-    typeId: ReferenceTypeId,
+  get<RT extends RepositoryTypes>(
+    typeId: RT,
     id: string,
     params?: GetParams
-  ): ResourceMap[ReferenceTypeId] {
+  ): ResourceMap[RT] {
     return this._storage.get(
       this.projectKey,
       typeId,
       id,
       params
-    ) as ResourceMap[ReferenceTypeId]
+    ) as ResourceMap[RT]
   }
 
   // TODO: Not sure if we want to expose this...
-  getRepository<ReferenceTypeId extends keyof RepositoryMap>(
-    typeId: ReferenceTypeId
-  ): RepositoryMap[ReferenceTypeId] {
+  getRepository<RT extends keyof RepositoryMap>(
+    typeId: ServiceTypes
+  ): RepositoryMap[RT] {
     const service = this._services[typeId]
     if (service !== undefined) {
-      return service.repository as RepositoryMap[ReferenceTypeId]
+      return service.repository as RepositoryMap[RT]
     }
     throw new Error('No such repository')
   }

package/src/repositories/category.ts

@@ -6,6 +6,8 @@ import {
   CategoryDraft,
   CategorySetAssetDescriptionAction,
   CategorySetAssetSourcesAction,
+  CategorySetCustomFieldAction,
+  CategorySetCustomTypeAction,
   CategorySetDescriptionAction,
   CategorySetKeyAction,
   CategorySetMetaDescriptionAction,
@@ -51,6 +53,11 @@ export class CategoryRepository extends AbstractResourceRepository {
             ),
           }
         }) || [],
+      custom: createCustomFields(
+        draft.custom,
+        context.projectKey,
+        this._storage
+      ),
     }
     this.save(context, resource)
     return resource
@@ -141,5 +148,34 @@ export class CategoryRepository extends AbstractResourceRepository {
     ) => {
       resource.metaTitle = metaTitle
     },
+    setCustomType: (
+      context: RepositoryContext,
+      resource: Writable<Category>,
+      { type, fields }: CategorySetCustomTypeAction
+    ) => {
+      if (type) {
+        resource.custom = createCustomFields(
+          { type, fields },
+          context.projectKey,
+          this._storage
+        )
+      } else {
+        resource.custom = undefined
+      }
+    },
+    setCustomField: (
+      context: RepositoryContext,
+      resource: Writable<Category>,
+      { name, value }: CategorySetCustomFieldAction
+    ) => {
+      if (!resource.custom) {
+        return
+      }
+      if (value === null) {
+        delete resource.custom.fields[name]
+      } else {
+        resource.custom.fields[name] = value
+      }
+    },
   }
 }

package/src/repositories/channel.ts

@@ -1,10 +1,20 @@
 import {
   Channel,
+  ChannelChangeDescriptionAction,
+  ChannelChangeKeyAction,
+  ChannelChangeNameAction,
   ChannelDraft,
+  ChannelSetAddressAction,
+  ChannelSetCustomFieldAction,
+  ChannelSetCustomTypeAction,
+  ChannelSetGeoLocationAction,
+  ChannelUpdateAction,
   ReferenceTypeId,
 } from '@commercetools/platform-sdk'
+import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
+import { createAddress, createCustomFields } from './helpers'
 
 export class ChannelRepository extends AbstractResourceRepository {
   getTypeId(): ReferenceTypeId {
@@ -15,9 +25,103 @@ export class ChannelRepository extends AbstractResourceRepository {
     const resource: Channel = {
       ...getBaseResourceProperties(),
       key: draft.key,
+      name: draft.name,
+      description: draft.description,
       roles: draft.roles || [],
+      geoLocation: draft.geoLocation,
+      address: createAddress(draft.address, context.projectKey, this._storage),
+      custom: createCustomFields(
+        draft.custom,
+        context.projectKey,
+        this._storage
+      ),
     }
     this.save(context, resource)
     return resource
   }
+
+  actions: Partial<
+    Record<
+      ChannelUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<Channel>,
+        action: any
+      ) => void
+    >
+  > = {
+    changeKey: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { key }: ChannelChangeKeyAction
+    ) => {
+      resource.key = key
+    },
+
+    changeName: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { name }: ChannelChangeNameAction
+    ) => {
+      resource.name = name
+    },
+
+    changeDescription: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { description }: ChannelChangeDescriptionAction
+    ) => {
+      resource.description = description
+    },
+
+    setAddress: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { address }: ChannelSetAddressAction
+    ) => {
+      resource.address = createAddress(
+        address,
+        context.projectKey,
+        this._storage
+      )
+    },
+
+    setGeoLocation: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { geoLocation }: ChannelSetGeoLocationAction
+    ) => {
+      resource.geoLocation = geoLocation
+    },
+
+    setCustomType: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { type, fields }: ChannelSetCustomTypeAction
+    ) => {
+      if (type) {
+        resource.custom = createCustomFields(
+          { type, fields },
+          context.projectKey,
+          this._storage
+        )
+      } else {
+        resource.custom = undefined
+      }
+    },
+    setCustomField: (
+      context: RepositoryContext,
+      resource: Writable<Channel>,
+      { name, value }: ChannelSetCustomFieldAction
+    ) => {
+      if (!resource.custom) {
+        return
+      }
+      if (value === null) {
+        delete resource.custom.fields[name]
+      } else {
+        resource.custom.fields[name] = value
+      }
+    },
+  }
 }

package/src/repositories/customer-group.ts

@@ -2,12 +2,15 @@ import {
   CustomerGroup,
   CustomerGroupChangeNameAction,
   CustomerGroupDraft,
+  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 {
@@ -18,6 +21,11 @@ export class CustomerGroupRepository extends AbstractResourceRepository {
       ...getBaseResourceProperties(),
       key: draft.key,
       name: draft.groupName,
+      custom: createCustomFields(
+        draft.custom,
+        context.projectKey,
+        this._storage
+      ),
     }
     this.save(context, resource)
     return resource
@@ -38,5 +46,34 @@ export class CustomerGroupRepository extends AbstractResourceRepository {
     ) => {
       resource.name = name
     },
+    setCustomType: (
+      context: RepositoryContext,
+      resource: Writable<CustomerGroup>,
+      { type, fields }: CustomerGroupSetCustomTypeAction
+    ) => {
+      if (type) {
+        resource.custom = createCustomFields(
+          { type, fields },
+          context.projectKey,
+          this._storage
+        )
+      } else {
+        resource.custom = undefined
+      }
+    },
+    setCustomField: (
+      context: RepositoryContext,
+      resource: Writable<CustomerGroup>,
+      { name, value }: CustomerGroupSetCustomFieldAction
+    ) => {
+      if (!resource.custom) {
+        return
+      }
+      if (value === null) {
+        delete resource.custom.fields[name]
+      } else {
+        resource.custom.fields[name] = value
+      }
+    },
   }
 }

package/src/repositories/discount-code.ts

@@ -5,6 +5,8 @@ import {
   DiscountCodeChangeIsActiveAction,
   DiscountCodeDraft,
   DiscountCodeSetCartPredicateAction,
+  DiscountCodeSetCustomFieldAction,
+  DiscountCodeSetCustomTypeAction,
   DiscountCodeSetDescriptionAction,
   DiscountCodeSetMaxApplicationsAction,
   DiscountCodeSetMaxApplicationsPerCustomerAction,
@@ -18,6 +20,7 @@ import {
 import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
+import { createCustomFields } from './helpers'
 
 export class DiscountCodeRepository extends AbstractResourceRepository {
   getTypeId(): ReferenceTypeId {
@@ -45,6 +48,11 @@ export class DiscountCodeRepository extends AbstractResourceRepository {
       validUntil: draft.validUntil,
       maxApplications: draft.maxApplications,
       maxApplicationsPerCustomer: draft.maxApplicationsPerCustomer,
+      custom: createCustomFields(
+        draft.custom,
+        context.projectKey,
+        this._storage
+      ),
     }
     this.save(context, resource)
     return resource
@@ -138,5 +146,34 @@ export class DiscountCodeRepository extends AbstractResourceRepository {
       resource.validFrom = validFrom
       resource.validUntil = validUntil
     },
+    setCustomType: (
+      context: RepositoryContext,
+      resource: Writable<DiscountCode>,
+      { type, fields }: DiscountCodeSetCustomTypeAction
+    ) => {
+      if (type) {
+        resource.custom = createCustomFields(
+          { type, fields },
+          context.projectKey,
+          this._storage
+        )
+      } else {
+        resource.custom = undefined
+      }
+    },
+    setCustomField: (
+      context: RepositoryContext,
+      resource: Writable<DiscountCode>,
+      { name, value }: DiscountCodeSetCustomFieldAction
+    ) => {
+      if (!resource.custom) {
+        return
+      }
+      if (value === null) {
+        delete resource.custom.fields[name]
+      } else {
+        resource.custom.fields[name] = value
+      }
+    },
   }
 }