@labdigital/commercetools-mock 1.5.0 → 1.6.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "license": "MIT",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -79,9 +79,10 @@
     "build": "tsup",
     "build:server": "esbuild src/server.ts --bundle --outfile=dist/server.js --platform=node",
     "publish:ci": "pnpm build && pnpm changeset publish",
-    "check": "eslint src && tsc",
     "test": "vitest run",
     "test:ci": "vitest run --coverage",
-    "lint": "eslint src"
+    "check": "pnpm lint && tsc",
+    "format": "eslint src --fix ; prettier --write .",
+    "lint": "eslint src && prettier --check ."
   }
 }

package/src/constants.ts

@@ -1,4 +1,4 @@
 export const DEFAULT_API_HOSTNAME =
-  /^https:\/\/api\..*?\.commercetools.com:443$/
+	/^https:\/\/api\..*?\.commercetools.com:443$/
 export const DEFAULT_AUTH_HOSTNAME =
-  /^https:\/\/auth\..*?\.commercetools.com:443$/
+	/^https:\/\/auth\..*?\.commercetools.com:443$/

package/src/ctMock.ts

@@ -17,188 +17,188 @@ import { createServices } from './services/index.js'
 import { ProjectRepository } from './repositories/project.js'
 
 export type CommercetoolsMockOptions = {
-  validateCredentials: boolean
-  enableAuthentication: boolean
-  defaultProjectKey: string | undefined
-  apiHost: RegExp | string
-  authHost: RegExp | string
-  silent: boolean
+	validateCredentials: boolean
+	enableAuthentication: boolean
+	defaultProjectKey: string | undefined
+	apiHost: RegExp | string
+	authHost: RegExp | string
+	silent: boolean
 }
 
 type AppOptions = { silent?: boolean }
 
 const DEFAULT_OPTIONS: CommercetoolsMockOptions = {
-  enableAuthentication: false,
-  validateCredentials: false,
-  defaultProjectKey: undefined,
-  apiHost: DEFAULT_API_HOSTNAME,
-  authHost: DEFAULT_AUTH_HOSTNAME,
-  silent: false,
+	enableAuthentication: false,
+	validateCredentials: false,
+	defaultProjectKey: undefined,
+	apiHost: DEFAULT_API_HOSTNAME,
+	authHost: DEFAULT_AUTH_HOSTNAME,
+	silent: false,
 }
 
 export class CommercetoolsMock {
-  public app: express.Express
-  public options: CommercetoolsMockOptions
-
-  private _storage: AbstractStorage
-  private _oauth2: OAuth2Server
-  private _nockScopes: {
-    auth: nock.Scope | undefined
-    api: nock.Scope | undefined
-  } = { auth: undefined, api: undefined }
-  private _services: Services | null
-  private _repositories: RepositoryMap | null
-  private _projectService?: ProjectService
-
-  constructor(options: Partial<CommercetoolsMockOptions> = {}) {
-    this.options = { ...DEFAULT_OPTIONS, ...options }
-    this._services = null
-    this._repositories = null
-    this._projectService = undefined
-
-    this._storage = new InMemoryStorage()
-    this._oauth2 = new OAuth2Server({
-      enabled: this.options.enableAuthentication,
-      validate: this.options.validateCredentials,
-    })
-
-    this.app = this.createApp({ silent: this.options.silent })
-  }
-
-  start() {
-    // Order is important here when the hostnames match
-    this.mockAuthHost()
-    this.mockApiHost()
-  }
-
-  stop() {
-    this._nockScopes.auth?.persist(false)
-    this._nockScopes.auth = undefined
-
-    this._nockScopes.api?.persist(false)
-    this._nockScopes.api = undefined
-  }
-
-  clear() {
-    this._storage.clear()
-  }
-
-  project(projectKey?: string) {
-    if (!projectKey && !this.options.defaultProjectKey) {
-      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._repositories,
-      this._storage
-    )
-  }
-
-  runServer(port = 3000, options?: AppOptions) {
-    const server = this.app.listen(port, () => {
-      console.info(`Mock server listening at http://localhost:${port}`)
-    })
-    server.keepAliveTimeout = 60 * 1000
-  }
-
-  private createApp(options?: AppOptions): express.Express {
-    this._repositories = createRepositories(this._storage)
-
-    const app = express()
-
-    const projectRouter = express.Router({ mergeParams: true })
-    projectRouter.use(express.json())
-
-    if (!options?.silent) {
-      app.use(morgan('tiny'))
-    }
-    app.use('/oauth', this._oauth2.createRouter())
-
-    // Only enable auth middleware if we have enabled this
-    if (this.options.enableAuthentication) {
-      app.use('/:projectKey', this._oauth2.createMiddleware(), projectRouter)
-      app.use(
-        '/:projectKey/in-store/key=:storeKey',
-        this._oauth2.createMiddleware(),
-        projectRouter
-      )
-    } else {
-      app.use('/:projectKey', projectRouter)
-      app.use('/:projectKey/in-store/key=:storeKey', projectRouter)
-    }
-
-    // Register the rest api services in the router
-    this._services = createServices(projectRouter, this._repositories)
-    this._projectService = new ProjectService(
-      projectRouter,
-      this._repositories.project as ProjectRepository
-    )
-
-    app.use((err: Error, req: Request, resp: Response, next: NextFunction) => {
-      if (err instanceof CommercetoolsError) {
-        return resp.status(err.statusCode).send({
-          statusCode: err.statusCode,
-          message: err.message,
-          errors: [err.info],
-        })
-      } else {
-        console.error(err)
-        return resp.status(500).send({
-          error: err.message,
-        })
-      }
-    })
-
-    return app
-  }
-
-  private mockApiHost() {
-    const app = this.app
-
-    this._nockScopes.api = nock(this.options.apiHost)
-      .persist()
-      .get(/.*/)
-      .reply(async function (uri) {
-        const response = await supertest(app)
-          .get(uri)
-          .set(copyHeaders(this.req.headers))
-        return [response.status, response.body]
-      })
-      .post(/.*/)
-      .reply(async function (uri, body) {
-        const response = await supertest(app)
-          .post(uri)
-          .set(copyHeaders(this.req.headers))
-          .send(body)
-        return [response.status, response.body]
-      })
-      .delete(/.*/)
-      .reply(async function (uri, body) {
-        const response = await supertest(app)
-          .delete(uri)
-          .set(copyHeaders(this.req.headers))
-          .send(body)
-        return [response.status, response.body]
-      })
-  }
-
-  private mockAuthHost() {
-    const app = this.app
-
-    this._nockScopes.auth = nock(this.options.authHost)
-      .persist()
-      .post(/^\/oauth\/.*/)
-      .reply(async function (uri, body) {
-        const response = await supertest(app)
-          .post(uri + '?' + body)
-          .set(copyHeaders(this.req.headers))
-          .send()
-        return [response.status, response.body]
-      })
-  }
+	public app: express.Express
+	public options: CommercetoolsMockOptions
+
+	private _storage: AbstractStorage
+	private _oauth2: OAuth2Server
+	private _nockScopes: {
+		auth: nock.Scope | undefined
+		api: nock.Scope | undefined
+	} = { auth: undefined, api: undefined }
+	private _services: Services | null
+	private _repositories: RepositoryMap | null
+	private _projectService?: ProjectService
+
+	constructor(options: Partial<CommercetoolsMockOptions> = {}) {
+		this.options = { ...DEFAULT_OPTIONS, ...options }
+		this._services = null
+		this._repositories = null
+		this._projectService = undefined
+
+		this._storage = new InMemoryStorage()
+		this._oauth2 = new OAuth2Server({
+			enabled: this.options.enableAuthentication,
+			validate: this.options.validateCredentials,
+		})
+
+		this.app = this.createApp({ silent: this.options.silent })
+	}
+
+	start() {
+		// Order is important here when the hostnames match
+		this.mockAuthHost()
+		this.mockApiHost()
+	}
+
+	stop() {
+		this._nockScopes.auth?.persist(false)
+		this._nockScopes.auth = undefined
+
+		this._nockScopes.api?.persist(false)
+		this._nockScopes.api = undefined
+	}
+
+	clear() {
+		this._storage.clear()
+	}
+
+	project(projectKey?: string) {
+		if (!projectKey && !this.options.defaultProjectKey) {
+			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._repositories,
+			this._storage
+		)
+	}
+
+	runServer(port = 3000, options?: AppOptions) {
+		const server = this.app.listen(port, () => {
+			console.info(`Mock server listening at http://localhost:${port}`)
+		})
+		server.keepAliveTimeout = 60 * 1000
+	}
+
+	private createApp(options?: AppOptions): express.Express {
+		this._repositories = createRepositories(this._storage)
+
+		const app = express()
+
+		const projectRouter = express.Router({ mergeParams: true })
+		projectRouter.use(express.json())
+
+		if (!options?.silent) {
+			app.use(morgan('tiny'))
+		}
+		app.use('/oauth', this._oauth2.createRouter())
+
+		// Only enable auth middleware if we have enabled this
+		if (this.options.enableAuthentication) {
+			app.use('/:projectKey', this._oauth2.createMiddleware(), projectRouter)
+			app.use(
+				'/:projectKey/in-store/key=:storeKey',
+				this._oauth2.createMiddleware(),
+				projectRouter
+			)
+		} else {
+			app.use('/:projectKey', projectRouter)
+			app.use('/:projectKey/in-store/key=:storeKey', projectRouter)
+		}
+
+		// Register the rest api services in the router
+		this._services = createServices(projectRouter, this._repositories)
+		this._projectService = new ProjectService(
+			projectRouter,
+			this._repositories.project as ProjectRepository
+		)
+
+		app.use((err: Error, req: Request, resp: Response, next: NextFunction) => {
+			if (err instanceof CommercetoolsError) {
+				return resp.status(err.statusCode).send({
+					statusCode: err.statusCode,
+					message: err.message,
+					errors: [err.info],
+				})
+			} else {
+				console.error(err)
+				return resp.status(500).send({
+					error: err.message,
+				})
+			}
+		})
+
+		return app
+	}
+
+	private mockApiHost() {
+		const app = this.app
+
+		this._nockScopes.api = nock(this.options.apiHost)
+			.persist()
+			.get(/.*/)
+			.reply(async function (uri) {
+				const response = await supertest(app)
+					.get(uri)
+					.set(copyHeaders(this.req.headers))
+				return [response.status, response.body]
+			})
+			.post(/.*/)
+			.reply(async function (uri, body) {
+				const response = await supertest(app)
+					.post(uri)
+					.set(copyHeaders(this.req.headers))
+					.send(body)
+				return [response.status, response.body]
+			})
+			.delete(/.*/)
+			.reply(async function (uri, body) {
+				const response = await supertest(app)
+					.delete(uri)
+					.set(copyHeaders(this.req.headers))
+					.send(body)
+				return [response.status, response.body]
+			})
+	}
+
+	private mockAuthHost() {
+		const app = this.app
+
+		this._nockScopes.auth = nock(this.options.authHost)
+			.persist()
+			.post(/^\/oauth\/.*/)
+			.reply(async function (uri, body) {
+				const response = await supertest(app)
+					.post(uri + '?' + body)
+					.set(copyHeaders(this.req.headers))
+					.send()
+				return [response.status, response.body]
+			})
+	}
 }

package/src/exceptions.ts

@@ -1,19 +1,19 @@
 export abstract class BaseError {
-  abstract message: string
+	abstract message: string
 }
 
 export class CommercetoolsError<T extends BaseError> extends Error {
-  info: T
-  statusCode: number
+	info: T
+	statusCode: number
 
-  constructor(info: T, statusCode = 400) {
-    super(info.message)
-    this.info = info
-    this.statusCode = statusCode || 500
-  }
+	constructor(info: T, statusCode = 400) {
+		super(info.message)
+		this.info = info
+		this.statusCode = statusCode || 500
+	}
 }
 
 export interface InvalidRequestError {
-  readonly code: 'invalid_request'
-  readonly message: string
+	readonly code: 'invalid_request'
+	readonly message: string
 }

package/src/helpers.ts

@@ -2,10 +2,10 @@ import { ParsedQs } from 'qs'
 import { v4 as uuidv4 } from 'uuid'
 
 export const getBaseResourceProperties = () => ({
-  id: uuidv4(),
-  createdAt: new Date().toISOString(),
-  lastModifiedAt: new Date().toISOString(),
-  version: 0,
+	id: uuidv4(),
+	createdAt: new Date().toISOString(),
+	lastModifiedAt: new Date().toISOString(),
+	version: 0,
 })
 
 /**
@@ -13,36 +13,36 @@ export const getBaseResourceProperties = () => ({
  * return obj['foo']['bar']['value']
  */
 export const nestedLookup = (obj: any, path: string): any => {
-  if (!path || path === '') {
-    return obj
-  }
+	if (!path || path === '') {
+		return obj
+	}
 
-  const parts = path.split('.')
-  let val = obj
+	const parts = path.split('.')
+	let val = obj
 
-  for (let i = 0; i < parts.length; i++) {
-    const part = parts[i]
-    if (val == undefined) {
-      return undefined
-    }
+	for (let i = 0; i < parts.length; i++) {
+		const part = parts[i]
+		if (val == undefined) {
+			return undefined
+		}
 
-    val = val[part]
-  }
+		val = val[part]
+	}
 
-  return val
+	return val
 }
 
 export const QueryParamsAsArray = (
-  input: string | ParsedQs | string[] | ParsedQs[] | undefined
+	input: string | ParsedQs | string[] | ParsedQs[] | undefined
 ): string[] => {
-  if (input == undefined) {
-    return []
-  }
-
-  if (Array.isArray(input)) {
-    return input as string[]
-  }
-  return [input] as string[]
+	if (input == undefined) {
+		return []
+	}
+
+	if (Array.isArray(input)) {
+		return input as string[]
+	}
+	return [input] as string[]
 }
 
 export const cloneObject = <T>(o: T): T => JSON.parse(JSON.stringify(o))