@labdigital/commercetools-mock 0.5.16 → 0.5.19

package/dist/repositories/abstract.d.ts

@@ -4,6 +4,8 @@ import { AbstractStorage } from '../storage';
 export declare type QueryParams = {
     expand?: string[];
     where?: string[];
+    offset?: number;
+    limit?: number;
 };
 export declare type GetParams = {
     expand?: string[];

package/dist/repositories/customer.d.ts

@@ -3,4 +3,5 @@ import { AbstractResourceRepository } from './abstract';
 export declare class CustomerRepository extends AbstractResourceRepository {
     getTypeId(): ReferenceTypeId;
     create(projectKey: string, draft: CustomerDraft): Customer;
+    getMe(projectKey: string): Customer | undefined;
 }

package/dist/repositories/payment.d.ts

@@ -1,4 +1,4 @@
-import { Payment, PaymentAddTransactionAction, PaymentDraft, PaymentSetCustomFieldAction, PaymentSetCustomTypeAction, ReferenceTypeId, TransactionDraft } from '@commercetools/platform-sdk';
+import { Payment, PaymentAddTransactionAction, PaymentChangeTransactionStateAction, PaymentDraft, PaymentSetCustomFieldAction, PaymentSetCustomTypeAction, PaymentTransitionStateAction, ReferenceTypeId, TransactionDraft } from '@commercetools/platform-sdk';
 import { AbstractResourceRepository } from './abstract';
 import { Writable } from '../types';
 export declare class PaymentRepository extends AbstractResourceRepository {
@@ -17,5 +17,7 @@ export declare class PaymentRepository extends AbstractResourceRepository {
         setCustomField: (projectKey: string, resource: Payment, { name, value }: PaymentSetCustomFieldAction) => void;
         setCustomType: (projectKey: string, resource: Writable<Payment>, { type, fields }: PaymentSetCustomTypeAction) => void;
         addTransaction: (projectKey: string, resource: Writable<Payment>, { transaction }: PaymentAddTransactionAction) => void;
+        changeTransactionState: (_projectKey: string, resource: Writable<Payment>, { transactionId, state }: PaymentChangeTransactionStateAction) => void;
+        transitionState: (projectKey: string, resource: Writable<Payment>, { state }: PaymentTransitionStateAction) => void;
     };
 }

package/dist/services/my-customer.d.ts

@@ -0,0 +1,12 @@
+import AbstractService from './abstract';
+import { Request, Response, Router } from 'express';
+import { AbstractStorage } from '../storage';
+import { CustomerRepository } from '../repositories/customer';
+export declare class MyCustomerService extends AbstractService {
+    repository: CustomerRepository;
+    constructor(parent: Router, storage: AbstractStorage);
+    getBasePath(): string;
+    registerRoutes(parent: Router): void;
+    getMe(request: Request, response: Response): Response<any, Record<string, any>>;
+    signUp(request: Request, response: Response): Response<any, Record<string, any>>;
+}

package/dist/services/shipping-method.d.ts

@@ -1,9 +1,10 @@
 import { ShippingMethodRepository } from '../repositories/shipping-method';
 import AbstractService from './abstract';
-import { Router } from 'express';
 import { AbstractStorage } from '../storage';
+import { Router } from 'express';
 export declare class ShippingMethodService extends AbstractService {
     repository: ShippingMethodRepository;
     constructor(parent: Router, storage: AbstractStorage);
     getBasePath(): string;
+    extraRoutes(parent: Router): void;
 }

package/dist/types.d.ts

@@ -18,7 +18,7 @@ export declare type Writable<T> = {
     -readonly [P in keyof T]: Writable<T[P]>;
 };
 export declare type RepositoryTypes = ReferenceTypeId | 'product-projection';
-export declare type ServiceTypes = RepositoryTypes | 'my-cart' | 'my-payment';
+export declare type ServiceTypes = RepositoryTypes | 'my-cart' | 'my-payment' | 'my-customer';
 export declare type Services = Partial<{
     [index in ServiceTypes]: AbstractService;
 }>;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.16",
+  "version": "0.5.19",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -17,9 +17,7 @@
     "build": "tsdx build --target=node",
     "test": "tsdx test",
     "lint": "tsdx lint",
-    "prepare": "tsdx build",
-    "size": "size-limit",
-    "analyze": "size-limit --why"
+    "prepare": "tsdx build"
   },
   "prettier": {
     "printWidth": 80,
@@ -30,19 +28,8 @@
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
   "module": "dist/commercetools--mock.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/commercetools--mock.cjs.production.min.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "dist/commercetools--mock.esm.js",
-      "limit": "10 KB"
-    }
-  ],
   "devDependencies": {
     "@babel/preset-typescript": "^7.16.7",
-    "@size-limit/preset-small-lib": "^7.0.5",
     "@types/basic-auth": "^1.1.3",
     "@types/deep-equal": "^1.0.1",
     "@types/express": "^4.17.13",
@@ -53,7 +40,6 @@
     "got": "^11.8.3",
     "husky": "^7.0.4",
     "nodemon": "^2.0.15",
-    "size-limit": "^7.0.5",
     "ts-node": "^10.4.0",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",

package/src/ctMock.ts

@@ -37,6 +37,7 @@ import { SubscriptionService } from './services/subscription'
 import { TaxCategoryService } from './services/tax-category'
 import { TypeService } from './services/type'
 import { ZoneService } from './services/zone'
+import { MyCustomerService } from './services/my-customer'
 
 export type CommercetoolsMockOptions = {
   validateCredentials: boolean
@@ -163,6 +164,7 @@ export class CommercetoolsMock {
       order: new OrderService(projectRouter, this._storage),
       payment: new PaymentService(projectRouter, this._storage),
       'my-cart': new MyCartService(projectRouter, this._storage),
+      'my-customer': new MyCustomerService(projectRouter, this._storage),
       'my-payment': new MyPaymentService(projectRouter, this._storage),
       'shipping-method': new ShippingMethodService(
         projectRouter,

package/src/repositories/abstract.ts

@@ -14,6 +14,8 @@ import { CommercetoolsError } from '../exceptions'
 export type QueryParams = {
   expand?: string[]
   where?: string[]
+  offset?: number
+  limit?: number
 }
 
 export type GetParams = {
@@ -69,6 +71,8 @@ export abstract class AbstractResourceRepository extends AbstractRepository {
     return this._storage.query(projectKey, this.getTypeId(), {
       expand: params.expand,
       where: params.where,
+      offset: params.offset,
+      limit: params.limit,
     })
   }
 

package/src/repositories/category.ts

@@ -30,6 +30,7 @@ export class CategoryRepository extends AbstractResourceRepository {
       name: draft.name,
       slug: draft.slug,
       orderHint: draft.orderHint || '',
+      externalId: draft.externalId || '',
       parent: draft.parent
         ? { typeId: 'category', id: draft.parent.id! }
         : undefined,

package/src/repositories/customer.ts

@@ -14,11 +14,19 @@ export class CustomerRepository extends AbstractResourceRepository {
     const resource: Customer = {
       ...getBaseResourceProperties(),
       email: draft.email,
-      password: draft.password,
+      password: Buffer.from(draft.password).toString('base64'),
       isEmailVerified: draft.isEmailVerified || false,
       addresses: [],
     }
     this.save(projectKey, resource)
     return resource
   }
+  getMe(projectKey: string): Customer | undefined {
+    const results = this._storage.query(projectKey, this.getTypeId(), {}) // grab the first customer you can find
+    if (results.count > 0) {
+      return results.results[0] as Customer
+    }
+
+    return
+  }
 }

package/src/repositories/discount-code.ts

@@ -25,7 +25,6 @@ export class DiscountCodeRepository extends AbstractResourceRepository {
   }
 
   create(projectKey: string, draft: DiscountCodeDraft): DiscountCode {
-    console.log(draft)
     const resource: DiscountCode = {
       ...getBaseResourceProperties(),
       applicationVersion: 1,

package/src/repositories/payment.ts

@@ -1,11 +1,15 @@
 import {
   Payment,
   PaymentAddTransactionAction,
+  PaymentChangeTransactionStateAction,
   PaymentDraft,
   PaymentSetCustomFieldAction,
   PaymentSetCustomTypeAction,
+  PaymentTransitionStateAction,
   ReferenceTypeId,
+  State,
   StateReference,
+  Transaction,
   TransactionDraft,
 } from '@commercetools/platform-sdk'
 import { AbstractResourceRepository } from './abstract'
@@ -111,10 +115,43 @@ export class PaymentRepository extends AbstractResourceRepository {
         this.transactionFromTransactionDraft(transaction, projectKey),
       ]
     },
+    changeTransactionState: (
+      _projectKey: string,
+      resource: Writable<Payment>,
+      { transactionId, state }: PaymentChangeTransactionStateAction
+    ) => {
+      const index = resource.transactions.findIndex(
+        (e: Transaction) => e.id === transactionId
+      )
+      const updatedTransaction: Transaction = {
+        ...resource.transactions[index],
+        state,
+      }
+      resource.transactions[index] = updatedTransaction
+    },
+    transitionState: (
+      projectKey: string,
+      resource: Writable<Payment>,
+      { state }: PaymentTransitionStateAction
+    ) => {
+      const stateObj = this._storage.getByResourceIdentifier(
+        projectKey,
+        state
+      ) as State | null
+
+      if (!stateObj) {
+        throw new Error(`State ${state} not found`)
+      }
+
+      resource.paymentStatus.state = {
+        typeId: 'state',
+        id: stateObj.id,
+        obj: stateObj,
+      }
+    },
     // addInterfaceInteraction: () => {},
     // changeAmountPlanned: () => {},
     // changeTransactionInteractionId: () => {},
-    // changeTransactionState: () => {},
     // changeTransactionTimestamp: () => {},
     // setAmountPaid: () => {},
     // setAmountRefunded: () => {},
@@ -129,6 +166,5 @@ export class PaymentRepository extends AbstractResourceRepository {
     // setMethodInfoName: () => {},
     // setStatusInterfaceCode: () => {},
     // setStatusInterfaceText: () => {},
-    // transitionState: () => {},
   }
 }

package/src/repositories/product-projection.ts

@@ -55,6 +55,8 @@ export class ProductProjectionRepository extends AbstractResourceRepository {
 
     const results = this._storage.query(projectKey, this.getTypeId(), {
       where: wherePredicate,
+      offset: query.offset ? Number(query.offset) : undefined,
+      limit: query.limit ? Number(query.limit) : undefined,
     }) //TODO: this is a partial implementation, but I don't really have the time to implement an actual search API right now
 
     return results

package/src/repositories/project.ts

@@ -146,7 +146,6 @@ export class ProjectRepository extends AbstractRepository {
       resource: Writable<Project>,
       { cartsConfiguration }: ProjectChangeCartsConfigurationAction
     ) => {
-      console.log(cartsConfiguration)
       resource.carts = cartsConfiguration || {
         countryTaxRateFallbackEnabled: false,
         deleteDaysAfterLastModification: 90,

package/src/services/abstract.ts

@@ -37,9 +37,14 @@ export default abstract class AbstractService {
   }
 
   get(request: Request, response: Response) {
+    const limit = this._parseParam(request.query.limit)
+    const offset = this._parseParam(request.query.offset)
+
     const result = this.repository.query(request.params.projectKey, {
       expand: this._parseParam(request.query.expand),
       where: this._parseParam(request.query.where),
+      limit: limit !== undefined ? Number(limit) : undefined,
+      offset: offset !== undefined ? Number(offset) : undefined,
     })
     return response.status(200).send(result)
   }
@@ -49,7 +54,6 @@ export default abstract class AbstractService {
     if (!result) {
       return response.status(404).send()
     }
-    console.log(JSON.stringify(result, null, 4))
     return response.status(200).send(result)
   }
 

package/src/services/my-customer.test.ts

@@ -0,0 +1,51 @@
+import { MyCustomerDraft } from '@commercetools/platform-sdk'
+import supertest from 'supertest'
+import { CommercetoolsMock } from '../index'
+
+const ctMock = new CommercetoolsMock()
+
+describe('Me', () => {
+  afterEach(() => {
+    ctMock.clear()
+  })
+
+  test('Create me', async () => {
+    const draft: MyCustomerDraft = {
+      email: 'test@example.org',
+      password: 'p4ssw0rd',
+    }
+
+    const response = await supertest(ctMock.app)
+      .post('/dummy/me/signup')
+      .send(draft)
+
+    expect(response.status).toBe(201)
+    expect(response.body).toEqual({
+      customer: {
+        ...draft,
+        password: 'cDRzc3cwcmQ=',
+        version: 1,
+        isEmailVerified: false,
+        addresses: [],
+        id: expect.anything(),
+        createdAt: expect.anything(),
+        lastModifiedAt: expect.anything(),
+      },
+    })
+  })
+
+  test('Get me', async () => {
+    const draft: MyCustomerDraft = {
+      email: 'test@example.org',
+      password: 'p4ssw0rd',
+    }
+    const createResponse = await supertest(ctMock.app)
+      .post('/dummy/me/signup')
+      .send(draft)
+
+    const response = await supertest(ctMock.app).get(`/dummy/me`)
+
+    expect(response.status).toBe(200)
+    expect(response.body).toEqual(createResponse.body.customer)
+  })
+})

package/src/services/my-customer.ts

@@ -0,0 +1,46 @@
+import AbstractService from './abstract'
+import { Request, Response, Router } from 'express'
+import { AbstractStorage } from '../storage'
+import { CustomerRepository } from '../repositories/customer'
+
+export class MyCustomerService extends AbstractService {
+  public repository: CustomerRepository
+
+  constructor(parent: Router, storage: AbstractStorage) {
+    super(parent)
+    this.repository = new CustomerRepository(storage)
+  }
+
+  getBasePath() {
+    return 'me'
+  }
+
+  registerRoutes(parent: Router) {
+    // Overwrite this function to be able to handle /me path.
+    const basePath = this.getBasePath()
+    const router = Router({ mergeParams: true })
+
+    this.extraRoutes(router)
+
+    router.get('', this.getMe.bind(this))
+
+    router.post('/signup', this.signUp.bind(this))
+
+    parent.use(`/${basePath}`, router)
+  }
+
+  getMe(request: Request, response: Response) {
+    const resource = this.repository.getMe(request.params.projectKey)
+    if (!resource) {
+      return response.status(404).send('Not found')
+    }
+    return response.status(200).send(resource)
+  }
+
+  signUp(request: Request, response: Response) {
+    const draft = request.body
+    const resource = this.repository.create(request.params.projectKey, draft)
+    const result = this._expandWithId(request, resource.id)
+    return response.status(this.createStatusCode).send({ customer: result })
+  }
+}

package/src/services/product-projection.test.ts

@@ -118,6 +118,26 @@ describe('Product Projection Search', () => {
     })
   })
 
+  test('Search product projection page 2', async () => {
+    const response = await supertest(ctMock.app).get(
+      '/dummy/product-projections/search?' +
+        qs.stringify({
+          filter: ['masterVariant.sku:"1337"'],
+          limit: 50,
+          offset: 100,
+        })
+    )
+
+    const projection: ProductProjection = response.body
+    expect(projection).toEqual({
+      count: 1,
+      limit: 50,
+      offset: 100,
+      total: 0,
+      results: [],
+    })
+  })
+
   test('Search product projection with query.filter', async () => {
     const response = await supertest(ctMock.app).get(
       '/dummy/product-projections/search?' +

package/src/services/shipping-method.test.ts

@@ -72,4 +72,31 @@ describe('Shipping method', () => {
     expect(response.status).toBe(200)
     expect(response.body).toEqual(createResponse.body)
   })
+
+  test('Get shipping methods matching cart', async () => {
+    const draft: ShippingMethodDraft = {
+      name: 'foo',
+      taxCategory: { typeId: 'tax-category', key: 'standard' },
+      isDefault: true,
+      zoneRates: [],
+    }
+    const createResponse = await supertest(ctMock.app)
+      .post('/dummy/shipping-methods')
+      .send(draft)
+
+    expect(createResponse.status).toBe(201)
+
+    const response = await supertest(ctMock.app).get(
+      `/dummy/shipping-methods/matching-cart?cartId=fake-cart-id`
+    )
+
+    expect(response.status).toBe(200)
+    expect(response.body).toEqual({
+      count: 1,
+      limit: 20,
+      offset: 0,
+      results: [createResponse.body],
+      total: 1,
+    })
+  })
 })

package/src/services/shipping-method.ts

@@ -1,7 +1,7 @@
 import { ShippingMethodRepository } from '../repositories/shipping-method'
 import AbstractService from './abstract'
-import { Router } from 'express'
 import { AbstractStorage } from '../storage'
+import { Request, Response, Router } from 'express'
 
 export class ShippingMethodService extends AbstractService {
   public repository: ShippingMethodRepository
@@ -9,9 +9,14 @@ export class ShippingMethodService extends AbstractService {
   constructor(parent: Router, storage: AbstractStorage) {
     super(parent)
     this.repository = new ShippingMethodRepository(storage)
+    this.registerRoutes(parent)
   }
 
   getBasePath() {
     return 'shipping-methods'
   }
+
+  extraRoutes(parent: Router) {
+    parent.get('/matching-cart', this.get.bind(this))
+  }
 }

package/src/types.ts

@@ -18,7 +18,11 @@ import { TaxCategoryRepository } from './repositories/tax-category'
 export type Writable<T> = { -readonly [P in keyof T]: Writable<T[P]> }
 
 export type RepositoryTypes = ReferenceTypeId | 'product-projection'
-export type ServiceTypes = RepositoryTypes | 'my-cart' | 'my-payment'
+export type ServiceTypes =
+  | RepositoryTypes
+  | 'my-cart'
+  | 'my-payment'
+  | 'my-customer'
 
 export type Services = Partial<
   {