@labdigital/commercetools-mock 2.17.0 → 2.18.0

package/src/repositories/shipping-method.ts

@@ -1,312 +0,0 @@
-import {
-	InvalidOperationError,
-	type ShippingMethod,
-	type ShippingMethodAddShippingRateAction,
-	type ShippingMethodAddZoneAction,
-	type ShippingMethodChangeIsDefaultAction,
-	type ShippingMethodChangeNameAction,
-	type ShippingMethodDraft,
-	type ShippingMethodRemoveZoneAction,
-	type ShippingMethodSetCustomFieldAction,
-	type ShippingMethodSetCustomTypeAction,
-	type ShippingMethodSetDescriptionAction,
-	type ShippingMethodSetKeyAction,
-	type ShippingMethodSetLocalizedDescriptionAction,
-	type ShippingMethodSetLocalizedNameAction,
-	type ShippingMethodSetPredicateAction,
-	type ShippingMethodUpdateAction,
-	type ShippingRate,
-	type ShippingRateDraft,
-	type ZoneRate,
-	type ZoneRateDraft,
-	type ZoneReference,
-} from '@commercetools/platform-sdk'
-import deepEqual from 'deep-equal'
-import { getBaseResourceProperties } from '../helpers.js'
-import type { Writable } from '../types.js'
-import {
-	AbstractResourceRepository,
-	GetParams,
-	RepositoryContext,
-} from './abstract.js'
-import {
-	createCustomFields,
-	createTypedMoney,
-	getReferenceFromResourceIdentifier,
-} from './helpers.js'
-import { CommercetoolsError } from '../exceptions.js'
-import { markMatchingShippingRate } from '../shippingCalculator.js'
-
-export class ShippingMethodRepository extends AbstractResourceRepository<'shipping-method'> {
-	getTypeId() {
-		return 'shipping-method' as const
-	}
-
-	create(
-		context: RepositoryContext,
-		draft: ShippingMethodDraft
-	): ShippingMethod {
-		const resource: ShippingMethod = {
-			...getBaseResourceProperties(),
-			...draft,
-			taxCategory: getReferenceFromResourceIdentifier(
-				draft.taxCategory,
-				context.projectKey,
-				this._storage
-			),
-			zoneRates: draft.zoneRates?.map((z) =>
-				this._transformZoneRateDraft(context, z)
-			),
-			custom: createCustomFields(
-				draft.custom,
-				context.projectKey,
-				this._storage
-			),
-		}
-		this.saveNew(context, resource)
-		return resource
-	}
-
-	private _transformZoneRateDraft = (
-		context: RepositoryContext,
-		draft: ZoneRateDraft
-	): ZoneRate => ({
-		...draft,
-		zone: getReferenceFromResourceIdentifier<ZoneReference>(
-			draft.zone,
-			context.projectKey,
-			this._storage
-		),
-		shippingRates: draft.shippingRates?.map(this._transformShippingRate),
-	})
-
-	private _transformShippingRate = (rate: ShippingRateDraft): ShippingRate => ({
-		price: createTypedMoney(rate.price),
-		freeAbove: rate.freeAbove && createTypedMoney(rate.freeAbove),
-		tiers: rate.tiers || [],
-	})
-
-	/*
-	 * Retrieves all the ShippingMethods that can ship to the shipping address of
-	 * the given Cart. Each ShippingMethod contains exactly one ShippingRate with
-	 * the flag isMatching set to true. This ShippingRate is used when the
-	 * ShippingMethod is added to the Cart.
-	 */
-	public matchingCart(
-		context: RepositoryContext,
-		cartId: string,
-		params: GetParams = {}
-	) {
-		const cart = this._storage.get(context.projectKey, 'cart', cartId)
-		if (!cart) {
-			return undefined
-		}
-
-		if (!cart.shippingAddress?.country) {
-			throw new CommercetoolsError<InvalidOperationError>({
-				code: 'InvalidOperation',
-				message: `The cart with ID '${cart.id}' does not have a shipping address set.`,
-			})
-		}
-
-		// Get all shipping methods that have a zone that matches the shipping address
-		const zones = this._storage.query<'zone'>(context.projectKey, 'zone', {
-			where: [`locations(country="${cart.shippingAddress.country}"))`],
-			limit: 100,
-		})
-		const zoneIds = zones.results.map((zone) => zone.id)
-		const shippingMethods = this.query(context, {
-			where: [
-				`zoneRates(zone(id in (:zoneIds)))`,
-				`zoneRates(shippingRates(price(currencyCode="${cart.totalPrice.currencyCode}")))`,
-			],
-			'var.zoneIds': zoneIds,
-			expand: params.expand,
-		})
-
-		// Make sure that each shipping method has exactly one shipping rate and
-		// that the shipping rate is marked as matching
-		const results = shippingMethods.results
-			.map((shippingMethod) => {
-				// Iterate through the zoneRates, process the shipping rates and filter
-				// out all zoneRates which have no matching shipping rates left
-				const rates = shippingMethod.zoneRates
-					.map((zoneRate) => ({
-						zone: zoneRate.zone,
-
-						// Iterate through the shippingRates and mark the matching ones
-						// then we filter out the non-matching ones
-						shippingRates: zoneRate.shippingRates
-							.map((rate) => markMatchingShippingRate(cart, rate))
-							.filter((rate) => rate.isMatching),
-					}))
-					.filter((zoneRate) => zoneRate.shippingRates.length > 0)
-
-				return {
-					...shippingMethod,
-					zoneRates: rates,
-				}
-			})
-			.filter((shippingMethod) => shippingMethod.zoneRates.length > 0)
-
-		return {
-			...shippingMethods,
-			results: results,
-		}
-	}
-
-	actions: Partial<
-		Record<
-			ShippingMethodUpdateAction['action'],
-			(
-				context: RepositoryContext,
-				resource: Writable<ShippingMethod>,
-				action: any
-			) => void
-		>
-	> = {
-		addShippingRate: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ shippingRate, zone }: ShippingMethodAddShippingRateAction
-		) => {
-			const rate = this._transformShippingRate(shippingRate)
-
-			resource.zoneRates.forEach((zoneRate) => {
-				if (zoneRate.zone.id === zone.id) {
-					zoneRate.shippingRates.push(rate)
-					return
-				}
-			})
-			resource.zoneRates.push({
-				zone: {
-					typeId: 'zone',
-					id: zone.id!,
-				},
-				shippingRates: [rate],
-			})
-		},
-		removeShippingRate: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ shippingRate, zone }: ShippingMethodAddShippingRateAction
-		) => {
-			const rate = this._transformShippingRate(shippingRate)
-
-			resource.zoneRates.forEach((zoneRate) => {
-				if (zoneRate.zone.id === zone.id) {
-					zoneRate.shippingRates = zoneRate.shippingRates.filter(
-						(otherRate) => !deepEqual(rate, otherRate)
-					)
-				}
-			})
-		},
-		addZone: (
-			context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ zone }: ShippingMethodAddZoneAction
-		) => {
-			const zoneReference = getReferenceFromResourceIdentifier<ZoneReference>(
-				zone,
-				context.projectKey,
-				this._storage
-			)
-
-			if (resource.zoneRates === undefined) {
-				resource.zoneRates = []
-			}
-
-			resource.zoneRates.push({
-				zone: zoneReference,
-				shippingRates: [],
-			})
-		},
-		removeZone: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ zone }: ShippingMethodRemoveZoneAction
-		) => {
-			resource.zoneRates = resource.zoneRates.filter(
-				(zoneRate) => zoneRate.zone.id !== zone.id
-			)
-		},
-		setKey: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ key }: ShippingMethodSetKeyAction
-		) => {
-			resource.key = key
-		},
-		setDescription: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ description }: ShippingMethodSetDescriptionAction
-		) => {
-			resource.description = description
-		},
-		setLocalizedDescription: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ localizedDescription }: ShippingMethodSetLocalizedDescriptionAction
-		) => {
-			resource.localizedDescription = localizedDescription
-		},
-		setLocalizedName: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ localizedName }: ShippingMethodSetLocalizedNameAction
-		) => {
-			resource.localizedName = localizedName
-		},
-		setPredicate: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ predicate }: ShippingMethodSetPredicateAction
-		) => {
-			resource.predicate = predicate
-		},
-		changeIsDefault: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ isDefault }: ShippingMethodChangeIsDefaultAction
-		) => {
-			resource.isDefault = isDefault
-		},
-		changeName: (
-			_context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ name }: ShippingMethodChangeNameAction
-		) => {
-			resource.name = name
-		},
-		setCustomType: (
-			context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ type, fields }: ShippingMethodSetCustomTypeAction
-		) => {
-			if (type) {
-				resource.custom = createCustomFields(
-					{ type, fields },
-					context.projectKey,
-					this._storage
-				)
-			} else {
-				resource.custom = undefined
-			}
-		},
-		setCustomField: (
-			context: RepositoryContext,
-			resource: Writable<ShippingMethod>,
-			{ name, value }: ShippingMethodSetCustomFieldAction
-		) => {
-			if (!resource.custom) {
-				return
-			}
-			if (value === null) {
-				delete resource.custom.fields[name]
-			} else {
-				resource.custom.fields[name] = value
-			}
-		},
-	}
-}

package/src/repositories/shopping-list.ts

@@ -1,392 +0,0 @@
-import type {
-	CustomerReference,
-	GeneralError,
-	LineItemDraft,
-	Product,
-	ProductPagedQueryResponse,
-	ShoppingList,
-	ShoppingListAddLineItemAction,
-	ShoppingListChangeLineItemQuantityAction,
-	ShoppingListChangeNameAction,
-	ShoppingListDraft,
-	ShoppingListLineItem,
-	ShoppingListRemoveLineItemAction,
-	ShoppingListSetAnonymousIdAction,
-	ShoppingListSetCustomFieldAction,
-	ShoppingListSetCustomTypeAction,
-	ShoppingListSetCustomerAction,
-	ShoppingListSetDeleteDaysAfterLastModificationAction,
-	ShoppingListSetDescriptionAction,
-	ShoppingListSetKeyAction,
-	ShoppingListSetSlugAction,
-	ShoppingListSetStoreAction,
-} from '@commercetools/platform-sdk'
-import { v4 as uuidv4 } from 'uuid'
-import { CommercetoolsError } from '../exceptions.js'
-import { getBaseResourceProperties } from '../helpers.js'
-import { Writable } from '../types.js'
-import { AbstractResourceRepository, RepositoryContext } from './abstract.js'
-import {
-	createCustomFields,
-	getReferenceFromResourceIdentifier,
-	getStoreKeyReference,
-} from './helpers.js'
-
-export class ShoppingListRepository extends AbstractResourceRepository<'shopping-list'> {
-	getTypeId() {
-		return 'shopping-list' as const
-	}
-
-	create(context: RepositoryContext, draft: ShoppingListDraft): ShoppingList {
-		const lineItems =
-			draft.lineItems?.map((draftLineItem) =>
-				this.draftLineItemtoLineItem(context.projectKey, draftLineItem)
-			) ?? []
-
-		const resource: ShoppingList = {
-			...getBaseResourceProperties(),
-			...draft,
-			custom: createCustomFields(
-				draft.custom,
-				context.projectKey,
-				this._storage
-			),
-			textLineItems: [],
-			lineItems,
-			customer: draft.customer
-				? getReferenceFromResourceIdentifier<CustomerReference>(
-						draft.customer,
-						context.projectKey,
-						this._storage
-					)
-				: undefined,
-			store: draft.store
-				? getStoreKeyReference(draft.store, context.projectKey, this._storage)
-				: undefined,
-		}
-		this.saveNew(context, resource)
-		return resource
-	}
-
-	actions = {
-		setKey: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ key }: ShoppingListSetKeyAction
-		) => {
-			resource.key = key
-		},
-		setSlug: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ slug }: ShoppingListSetSlugAction
-		) => {
-			resource.slug = slug
-		},
-		changeName: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ name }: ShoppingListChangeNameAction
-		) => {
-			resource.name = name
-		},
-		setDescription: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ description }: ShoppingListSetDescriptionAction
-		) => {
-			resource.description = description
-		},
-		setCustomer: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ customer }: ShoppingListSetCustomerAction
-		) => {
-			if (customer?.key) {
-				throw new Error('set customer on shoppinglist by key not implemented')
-			}
-			if (customer?.id) {
-				resource.customer = { typeId: 'customer', id: customer.id }
-			}
-		},
-		setStore: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ store }: ShoppingListSetStoreAction
-		) => {
-			if (store?.key) {
-				resource.store = { typeId: 'store', key: store.key }
-			}
-			if (store?.id) {
-				throw new Error('set store on shoppinglist by id not implemented')
-			}
-		},
-		setAnonymousId: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ anonymousId }: ShoppingListSetAnonymousIdAction
-		) => {
-			resource.anonymousId = anonymousId
-		},
-		setCustomType: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ type, fields }: ShoppingListSetCustomTypeAction
-		) => {
-			if (!type) {
-				resource.custom = undefined
-			} else {
-				const resolvedType = this._storage.getByResourceIdentifier(
-					context.projectKey,
-					type
-				)
-				if (!resolvedType) {
-					throw new Error(`Type ${type} not found`)
-				}
-
-				resource.custom = {
-					type: {
-						typeId: 'type',
-						id: resolvedType.id,
-					},
-					fields: fields || {},
-				}
-			}
-		},
-		setCustomField: (
-			context: RepositoryContext,
-			resource: ShoppingList,
-			{ name, value }: ShoppingListSetCustomFieldAction
-		) => {
-			if (!resource.custom) {
-				throw new Error('Resource has no custom field')
-			}
-			resource.custom.fields[name] = value
-		},
-		setDeleteDaysAfterLastModification: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{
-				deleteDaysAfterLastModification,
-			}: ShoppingListSetDeleteDaysAfterLastModificationAction
-		) => {
-			resource.deleteDaysAfterLastModification = deleteDaysAfterLastModification
-		},
-		addLineItem: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ productId, variantId, sku, quantity = 1 }: ShoppingListAddLineItemAction
-		) => {
-			let product: Product | null = null
-
-			if (productId) {
-				// Fetch product and variant by ID
-				product = this._storage.get(
-					context.projectKey,
-					'product',
-					productId,
-					{}
-				)
-			} else if (sku) {
-				// Fetch product and variant by SKU
-				const items = this._storage.query(context.projectKey, 'product', {
-					where: [
-						`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
-					],
-				}) as ProductPagedQueryResponse
-
-				if (items.count === 1) {
-					product = items.results[0]
-				}
-			}
-
-			if (!product) {
-				// Check if product is found
-				throw new CommercetoolsError<GeneralError>({
-					code: 'General',
-					message: sku
-						? `A product containing a variant with SKU '${sku}' not found.`
-						: `A product with ID '${productId}' not found.`,
-				})
-			}
-
-			let varId: number | undefined = variantId
-			if (sku) {
-				varId = [
-					product.masterData.current.masterVariant,
-					...product.masterData.current.variants,
-				].find((x) => x.sku === sku)?.id
-			}
-			if (!varId) {
-				varId = product.masterData.current.masterVariant.id
-			}
-
-			const alreadyAdded = resource.lineItems.some(
-				(x) => x.productId === product?.id && x.variantId === varId
-			)
-			if (alreadyAdded) {
-				// increase quantity and update total price
-				resource.lineItems.forEach((x) => {
-					if (x.productId === product?.id && x.variantId === varId) {
-						x.quantity += quantity
-					}
-				})
-			} else {
-				// add line item
-				resource.lineItems.push({
-					addedAt: new Date().toISOString(),
-					id: uuidv4(),
-					productId: product.id,
-					productSlug: product.masterData.current.slug,
-					productType: product.productType,
-					name: product.masterData.current.name,
-					variantId: varId,
-					quantity,
-				})
-			}
-		},
-		removeLineItem: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{ lineItemId, quantity }: ShoppingListRemoveLineItemAction
-		) => {
-			const lineItem = resource.lineItems.find((x) => x.id === lineItemId)
-			if (!lineItem) {
-				// Check if product is found
-				throw new CommercetoolsError<GeneralError>({
-					code: 'General',
-					message: `A line item with ID '${lineItemId}' not found.`,
-				})
-			}
-
-			const shouldDelete = !quantity || quantity >= lineItem.quantity
-			if (shouldDelete) {
-				// delete line item
-				resource.lineItems = resource.lineItems.filter(
-					(x) => x.id !== lineItemId
-				)
-			} else {
-				// decrease quantity and update total price
-				resource.lineItems.forEach((x) => {
-					if (x.id === lineItemId && quantity) {
-						x.quantity -= quantity
-					}
-				})
-			}
-		},
-		changeLineItemQuantity: (
-			context: RepositoryContext,
-			resource: Writable<ShoppingList>,
-			{
-				lineItemId,
-				lineItemKey,
-				quantity,
-			}: ShoppingListChangeLineItemQuantityAction
-		) => {
-			let lineItem: Writable<ShoppingListLineItem> | undefined
-
-			if (lineItemId) {
-				lineItem = resource.lineItems.find((x) => x.id === lineItemId)
-				if (!lineItem) {
-					throw new CommercetoolsError<GeneralError>({
-						code: 'General',
-						message: `A line item with ID '${lineItemId}' not found.`,
-					})
-				}
-			} else if (lineItemKey) {
-				lineItem = resource.lineItems.find((x) => x.id === lineItemId)
-				if (!lineItem) {
-					throw new CommercetoolsError<GeneralError>({
-						code: 'General',
-						message: `A line item with Key '${lineItemKey}' not found.`,
-					})
-				}
-			} else {
-				throw new CommercetoolsError<GeneralError>({
-					code: 'General',
-					message: `Either lineItemid or lineItemKey needs to be provided.`,
-				})
-			}
-
-			if (quantity === 0) {
-				// delete line item
-				resource.lineItems = resource.lineItems.filter(
-					(x) => x.id !== lineItemId
-				)
-			} else {
-				resource.lineItems.forEach((x) => {
-					if (x.id === lineItemId && quantity) {
-						x.quantity = quantity
-					}
-				})
-			}
-		},
-	}
-
-	draftLineItemtoLineItem = (
-		projectKey: string,
-		draftLineItem: LineItemDraft
-	): ShoppingListLineItem => {
-		const { sku, productId, variantId } = draftLineItem
-
-		const lineItem: Writable<ShoppingListLineItem> = {
-			...getBaseResourceProperties(),
-			...draftLineItem,
-			addedAt: draftLineItem.addedAt ?? '',
-			productId: draftLineItem.productId ?? '',
-			name: {},
-			variantId,
-			quantity: draftLineItem.quantity ?? 1,
-			productType: { typeId: 'product-type', id: '' },
-			custom: createCustomFields(
-				draftLineItem.custom,
-				projectKey,
-				this._storage
-			),
-		}
-
-		if (productId && variantId) {
-			return lineItem
-		}
-
-		if (sku) {
-			const items = this._storage.query(projectKey, 'product', {
-				where: [
-					`masterData(current(masterVariant(sku="${sku}"))) or masterData(current(variants(sku="${sku}")))`,
-				],
-			}) as ProductPagedQueryResponse
-
-			if (items.count === 0) {
-				throw new Error(`Product with sku ${sku} not found`)
-			}
-
-			const product = items.results[0]
-			const allVariants = [
-				product.masterData.current.masterVariant,
-				...product.masterData.current.variants,
-			]
-			const variantId = allVariants.find((e) => e.sku === sku)?.id
-			lineItem.variantId = variantId
-			lineItem.productId = product.id
-			return lineItem
-		}
-
-		if (productId) {
-			const items = this._storage.query(projectKey, 'product', {
-				where: [`id="${productId}"`],
-			}) as ProductPagedQueryResponse
-
-			if (items.count === 0) {
-				throw new Error(`Product with id ${productId} not found`)
-			}
-
-			const variantId = items.results[0].masterData.current.masterVariant.id
-			lineItem.variantId = variantId
-			return lineItem
-		}
-
-		throw new Error(
-			`must provide either sku, productId or variantId for ShoppingListLineItem`
-		)
-	}
-}