@labdigital/commercetools-mock 0.10.0 → 0.11.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/commercetools--mock.esm.js",
@@ -39,12 +39,13 @@
     "perplex": "^0.11.0",
     "pratt": "^0.7.0",
     "supertest": "^6.1.6",
+    "type-fest": "^3.1.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.18.9",
     "@babel/preset-typescript": "^7.18.6",
-    "@commercetools/platform-sdk": "2.8.0",
+    "@commercetools/platform-sdk": "4.0.0",
     "@types/basic-auth": "^1.1.3",
     "@types/body-parser": "^1.19.2",
     "@types/deep-equal": "^1.0.1",

package/src/ctMock.ts

@@ -3,7 +3,7 @@ import express, { NextFunction, Request, Response } from 'express'
 import supertest from 'supertest'
 import morgan from 'morgan'
 import { AbstractStorage, InMemoryStorage } from './storage'
-import { Repositories, Services } from './types'
+import { Services } from './types'
 import { CommercetoolsError } from './exceptions'
 import { OAuth2Server } from './oauth/server'
 import { ProjectAPI } from './projectAPI'
@@ -12,7 +12,7 @@ import { DEFAULT_API_HOSTNAME, DEFAULT_AUTH_HOSTNAME } from './constants'
 
 // Services
 import { ProjectService } from './services/project'
-import { createRepositories } from './repositories'
+import { createRepositories, RepositoryMap } from './repositories'
 import { createServices } from './services'
 import { ProjectRepository } from 'repositories/project'
 
@@ -46,14 +46,14 @@ export class CommercetoolsMock {
     auth: nock.Scope | undefined
     api: nock.Scope | undefined
   } = { auth: undefined, api: undefined }
-  private _services: Services
-  private _repositories: Repositories
+  private _services: Services | null
+  private _repositories: RepositoryMap | null
   private _projectService?: ProjectService
 
   constructor(options: Partial<CommercetoolsMockOptions> = {}) {
     this.options = { ...DEFAULT_OPTIONS, ...options }
-    this._services = {}
-    this._repositories = {}
+    this._services = null
+    this._repositories = null
     this._projectService = undefined
 
     this._storage = new InMemoryStorage()
@@ -88,9 +88,13 @@ export class CommercetoolsMock {
       throw new Error('No projectKey passed and no default set')
     }
 
+    if (this._repositories === null) {
+      throw new Error('repositories not initialized yet')
+    }
+
     return new ProjectAPI(
       projectKey || this.options.defaultProjectKey!,
-      this._services,
+      this._repositories,
       this._storage
     )
   }
@@ -103,6 +107,8 @@ export class CommercetoolsMock {
   }
 
   private createApp(options?: AppOptions): express.Express {
+    this._repositories = createRepositories(this._storage)
+
     const app = express()
 
     const projectRouter = express.Router({ mergeParams: true })
@@ -126,12 +132,12 @@ export class CommercetoolsMock {
       app.use('/:projectKey/in-store/key=:storeKey', projectRouter)
     }
 
-    this._repositories = createRepositories(this._storage)
+    // Register the rest api services in the router
+    this._services = createServices(projectRouter, this._repositories)
     this._projectService = new ProjectService(
       projectRouter,
       this._repositories.project as ProjectRepository
     )
-    this._services = createServices(projectRouter, this._repositories)
 
     app.use((err: Error, req: Request, resp: Response, next: NextFunction) => {
       if (err instanceof CommercetoolsError) {

package/src/helpers.ts

@@ -1,5 +1,5 @@
-import { v4 as uuidv4 } from 'uuid'
 import { ParsedQs } from 'qs'
+import { v4 as uuidv4 } from 'uuid'
 
 export const getBaseResourceProperties = () => ({
   id: uuidv4(),

package/src/lib/projectionSearchFilter.ts

@@ -5,8 +5,8 @@
 import { ProductProjection, ProductVariant } from '@commercetools/platform-sdk'
 import perplex from 'perplex'
 import Parser from 'pratt'
-import { nestedLookup } from '../helpers'
 import { Writable } from '../types'
+import { nestedLookup } from '../helpers'
 
 type MatchFunc = (target: any) => boolean
 
@@ -99,7 +99,8 @@ const parseFilter = (filter: string): ExpressionSet => {
     .nud('IDENTIFIER', 100, (t) => t.token.match)
     .led(':', 100, ({ left, bp }) => {
       const parsed: any = parser.parse({ terminals: [bp - 1] })
-      const expressions: RangeExpression[] | FilterExpression[] | TypeSymbol[] = !Array.isArray(parsed) ? [parsed] : parsed
+      const expressions: RangeExpression[] | FilterExpression[] | TypeSymbol[] =
+        !Array.isArray(parsed) ? [parsed] : parsed
 
       // Make sure we only have one type of expression (cannot mix)
       const unique = new Set(expressions.map((expr) => expr.type))

package/src/priceSelector.test.ts

@@ -1,6 +1,4 @@
-import {
-  ProductProjection,
-} from '@commercetools/platform-sdk'
+import { ProductProjection } from '@commercetools/platform-sdk'
 import { applyPriceSelector } from './priceSelector'
 
 describe('priceSelector', () => {

package/src/product-projection-search.ts

@@ -60,7 +60,6 @@ export class ProductProjectionSearch {
     let resources = this._storage
       .all(projectKey, 'product')
       .map((r) => this.transform(r, params.staged ?? false))
-      .filter((p): p is ProductProjection => p !== null)
       .filter((p) => {
         if (!params.staged ?? false) {
           return p.published
@@ -145,9 +144,8 @@ export class ProductProjectionSearch {
     }
   }
 
-  transform(product: Product, staged: boolean): ProductProjection | null {
+  transform(product: Product, staged: boolean): ProductProjection {
     const obj = !staged ? product.masterData.current : product.masterData.staged
-    if (!obj) return null
 
     return {
       id: product.id,

package/src/projectAPI.test.ts

@@ -0,0 +1,7 @@
+import { CommercetoolsMock } from './index'
+
+test('getRepository', async () => {
+  const ctMock = new CommercetoolsMock()
+  const repo = ctMock.project('my-project-key').getRepository('order')
+  repo.get({ projectKey: 'unittest' }, '1234')
+})

package/src/projectAPI.ts

@@ -1,34 +1,31 @@
-import { ReferenceTypeId } from '@commercetools/platform-sdk'
 import { GetParams } from 'repositories/abstract'
 import { getBaseResourceProperties } from './helpers'
 import { AbstractStorage } from './storage'
-import {
-  RepositoryMap,
-  RepositoryTypes,
-  ResourceMap,
-  Services,
-  ServiceTypes,
-} from './types'
+import { RepositoryMap } from './repositories'
+import { ResourceMap, ResourceType } from './types'
 
 export class ProjectAPI {
   private projectKey: string
   private _storage: AbstractStorage
-  private _services: Services
+  private _repositories: RepositoryMap
 
   constructor(
     projectKey: string,
-    services: Services,
+    repositories: RepositoryMap,
     storage: AbstractStorage
   ) {
     this.projectKey = projectKey
     this._storage = storage
-    this._services = services
+    this._repositories = repositories
   }
 
-  add(typeId: ReferenceTypeId, resource: ResourceMap[ReferenceTypeId]) {
-    const service = this._services[typeId]
-    if (service) {
-      this._storage.add(this.projectKey, typeId as ReferenceTypeId, {
+  add<T extends keyof RepositoryMap & keyof ResourceMap>(
+    typeId: T,
+    resource: ResourceMap[T]
+  ) {
+    const repository = this._repositories[typeId]
+    if (repository) {
+      this._storage.add(this.projectKey, typeId, {
         ...getBaseResourceProperties(),
         ...resource,
       })
@@ -37,7 +34,7 @@ export class ProjectAPI {
     }
   }
 
-  get<RT extends RepositoryTypes>(
+  get<RT extends ResourceType>(
     typeId: RT,
     id: string,
     params?: GetParams
@@ -51,12 +48,10 @@ export class ProjectAPI {
   }
 
   // TODO: Not sure if we want to expose this...
-  getRepository<RT extends keyof RepositoryMap>(
-    typeId: ServiceTypes
-  ): RepositoryMap[RT] {
-    const service = this._services[typeId]
-    if (service !== undefined) {
-      return service.repository as RepositoryMap[RT]
+  getRepository<RT extends keyof RepositoryMap>(typeId: RT): RepositoryMap[RT] {
+    const repository = this._repositories[typeId]
+    if (repository !== undefined) {
+      return repository as RepositoryMap[RT]
     }
     throw new Error('No such repository')
   }

package/src/repositories/abstract.ts

@@ -1,16 +1,15 @@
-import { RepositoryTypes, Resource, Writable } from './../types'
-import deepEqual from 'deep-equal'
-
 import {
   BaseResource,
   Project,
   ResourceNotFoundError,
   UpdateAction,
 } from '@commercetools/platform-sdk'
-import { AbstractStorage } from '../storage'
-import { checkConcurrentModification } from './errors'
+import deepEqual from 'deep-equal'
 import { CommercetoolsError } from '../exceptions'
 import { cloneObject } from '../helpers'
+import { AbstractStorage } from '../storage'
+import { ResourceMap, ResourceType, ShallowWritable } from './../types'
+import { checkConcurrentModification } from './errors'
 
 export type QueryParams = {
   expand?: string[]
@@ -27,7 +26,8 @@ export type RepositoryContext = {
   projectKey: string
   storeKey?: string
 }
-export abstract class AbstractRepository {
+
+export abstract class AbstractRepository<R extends BaseResource | Project> {
   protected _storage: AbstractStorage
   protected actions: Partial<
     Record<
@@ -40,22 +40,22 @@ export abstract class AbstractRepository {
     this._storage = storage
   }
 
-  abstract saveNew({ projectKey }: RepositoryContext, resource: Resource): void
+  abstract saveNew({ projectKey }: RepositoryContext, resource: R): void
 
   abstract saveUpdate(
     { projectKey }: RepositoryContext,
     version: number,
-    resource: Resource
+    resource: R
   ): void
 
-  processUpdateActions<T extends Resource>(
+  processUpdateActions(
     context: RepositoryContext,
-    resource: T,
+    resource: R,
     version: number,
     actions: UpdateAction[]
-  ): T {
+  ): R {
     // Deep-copy
-    const updatedResource = cloneObject(resource) as Writable<Resource>
+    const updatedResource = cloneObject(resource) as ShallowWritable<R>
     const identifier = (resource as BaseResource).id
       ? (resource as BaseResource).id
       : (resource as Project).key
@@ -96,22 +96,26 @@ export abstract class AbstractRepository {
     if (!result) {
       throw new Error('invalid post process action')
     }
-    return result as T
+    return result
   }
 
-  postProcessResource<T extends Resource>(resource: T): T {
-    return resource
-  }
+  abstract postProcessResource(resource: any): any
 }
 
-export abstract class AbstractResourceRepository extends AbstractRepository {
-  abstract create(context: RepositoryContext, draft: any): BaseResource
-  abstract getTypeId(): RepositoryTypes
+export abstract class AbstractResourceRepository<
+  T extends ResourceType
+> extends AbstractRepository<ResourceMap[T]> {
+  abstract create(context: RepositoryContext, draft: any): ResourceMap[T]
+  abstract getTypeId(): T
 
   constructor(storage: AbstractStorage) {
     super(storage)
   }
 
+  postProcessResource(resource: ResourceMap[T]): ResourceMap[T] {
+    return resource
+  }
+
   query(context: RepositoryContext, params: QueryParams = {}) {
     const result = this._storage.query(context.projectKey, this.getTypeId(), {
       expand: params.expand,
@@ -129,7 +133,7 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
     context: RepositoryContext,
     id: string,
     params: GetParams = {}
-  ): BaseResource | null {
+  ): ResourceMap[T] | null {
     const resource = this._storage.get(
       context.projectKey,
       this.getTypeId(),
@@ -143,7 +147,7 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
     context: RepositoryContext,
     key: string,
     params: GetParams = {}
-  ): BaseResource | null {
+  ): ResourceMap[T] | null {
     const resource = this._storage.getByKey(
       context.projectKey,
       this.getTypeId(),
@@ -157,7 +161,7 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
     context: RepositoryContext,
     id: string,
     params: GetParams = {}
-  ): BaseResource | null {
+  ): ResourceMap[T] | null {
     const resource = this._storage.delete(
       context.projectKey,
       this.getTypeId(),
@@ -167,7 +171,10 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
     return resource ? this.postProcessResource(resource) : null
   }
 
-  saveNew(context: RepositoryContext, resource: Writable<BaseResource>) {
+  saveNew(
+    context: RepositoryContext,
+    resource: ShallowWritable<ResourceMap[T]>
+  ) {
     resource.version = 1
     this._storage.add(context.projectKey, this.getTypeId(), resource as any)
   }
@@ -175,7 +182,7 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
   saveUpdate(
     context: RepositoryContext,
     version: number,
-    resource: Writable<BaseResource>
+    resource: ShallowWritable<ResourceMap[T]>
   ) {
     // Check if the resource still exists.
     const current = this._storage.get(

package/src/repositories/cart-discount.ts

@@ -14,16 +14,15 @@ import {
   CartDiscountValueFixed,
   CartDiscountValueGiftLineItem,
   CartDiscountValueRelative,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
 import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import { createTypedMoney } from './helpers'
 
-export class CartDiscountRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'cart-discount'
+export class CartDiscountRepository extends AbstractResourceRepository<'cart-discount'> {
+  getTypeId() {
+    return 'cart-discount' as const
   }
 
   create(context: RepositoryContext, draft: CartDiscountDraft): CartDiscount {

package/src/repositories/cart.ts

@@ -18,18 +18,17 @@ 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 {
@@ -46,21 +45,23 @@ export class CartRepository extends AbstractResourceRepository {
     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,
@@ -181,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,
@@ -403,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',

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 {

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 {

package/src/repositories/custom-object.ts

@@ -2,17 +2,16 @@ import {
   CustomObject,
   CustomObjectDraft,
   InvalidOperationError,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
-import { checkConcurrentModification } from './errors'
-import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { Writable } from '../types'
-import { cloneObject, getBaseResourceProperties } from '../helpers'
 import { CommercetoolsError } from '../exceptions'
+import { cloneObject, getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
+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(
@@ -34,7 +33,7 @@ export class CustomObjectRepository extends AbstractResourceRepository {
       }
 
       if (draft.value !== current.value) {
-        const updated = cloneObject(current)
+        const updated = cloneObject(current) as Writable<CustomObject>
         updated.value = draft.value
         updated.version += 1
         this.saveUpdate(context, draft.version, updated)
@@ -70,10 +69,7 @@ export class CustomObjectRepository extends AbstractResourceRepository {
     container: string,
     key: string
   ) {
-    const items = this._storage.all(
-      context.projectKey,
-      this.getTypeId()
-    ) as Array<CustomObject>
+    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 = {

package/src/repositories/customer.ts

@@ -5,16 +5,15 @@ import {
   CustomerSetAuthenticationModeAction,
   InvalidInputError,
   InvalidJsonInputError,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
 import { Writable } from 'types'
+import { CommercetoolsError } from '../exceptions'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { CommercetoolsError } from '../exceptions'
 
-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 {

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 {

package/src/repositories/errors.ts

@@ -1,6 +1,4 @@
-import {
-  ConcurrentModificationError,
-} from '@commercetools/platform-sdk'
+import { ConcurrentModificationError } from '@commercetools/platform-sdk'
 import { CommercetoolsError } from '../exceptions'
 
 export const checkConcurrentModification = (