@labdigital/commercetools-mock 0.10.0 → 0.11.0

package/src/repositories/product.ts

@@ -7,23 +7,24 @@ import {
   ProductPublishAction,
   ProductSetAttributeAction,
   ProductSetDescriptionAction,
+  ProductAddExternalImageAction,
+  ProductRemoveImageAction,
   ProductSetKeyAction,
   ProductTypeReference,
   ProductUpdateAction,
   ProductVariant,
   ProductVariantDraft,
-  ReferenceTypeId,
 } from '@commercetools/platform-sdk'
 import { v4 as uuidv4 } from 'uuid'
+import { Writable } from '../types'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { Writable } from '../types'
 import { getReferenceFromResourceIdentifier } from './helpers'
 import deepEqual from 'deep-equal'
 
-export class ProductRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'product'
+export class ProductRepository extends AbstractResourceRepository<'product'> {
+  getTypeId() {
+    return 'product' as const
   }
 
   create(context: RepositoryContext, draft: ProductDraft): Product {
@@ -100,7 +101,7 @@ export class ProductRepository extends AbstractResourceRepository {
     },
     unpublish: (
       context: RepositoryContext,
-      resource: Writable<Product>,
+      resource: Writable<Product>
       // { action }: ProductUnpublishAction
     ) => {
       resource.masterData.published = false
@@ -162,7 +163,7 @@ export class ProductRepository extends AbstractResourceRepository {
 
       return resource
     },
-    'setDescription': (
+    setDescription: (
       context: RepositoryContext,
       resource: Writable<Product>,
       { description, staged }: ProductSetDescriptionAction
@@ -176,7 +177,7 @@ export class ProductRepository extends AbstractResourceRepository {
       checkForStagedChanges(resource)
       return resource
     },
-    'setKey': (
+    setKey: (
       context: RepositoryContext,
       resource: Writable<Product>,
       { key }: ProductSetKeyAction
@@ -184,6 +185,114 @@ export class ProductRepository extends AbstractResourceRepository {
       resource.key = key
       return resource
     },
+    addExternalImage: (
+      context: RepositoryContext,
+      resource: Writable<Product>,
+      { variantId, sku, image, staged }: ProductAddExternalImageAction
+    ) => {
+      const addImg = (data: Writable<ProductData>) => {
+        const { variant, isMasterVariant, variantIndex } = getVariant(
+          data,
+          variantId,
+          sku
+        )
+        if (!variant) {
+          throw new Error(
+            `Variant with id ${variantId} or sku ${sku} not found on product ${resource.id}`
+          )
+        }
+
+        if (!variant.images) {
+          variant.images = []
+        } else {
+          const existingImage = variant.images.find((x) => x.url === image.url)
+          if (existingImage) {
+            throw new Error(
+              `Cannot add image '${image.url}' because product '${resource.id}' already has that image.`
+            )
+          }
+        }
+
+        // Add image
+        variant.images.push(image)
+
+        if (isMasterVariant) {
+          data.masterVariant = variant
+        } else {
+          data.variants[variantIndex] = variant
+        }
+      }
+
+      // If true, only the staged Attribute is set. If false, both current and
+      // staged Attribute is set.  Default is true
+      const onlyStaged = staged !== undefined ? staged : true
+
+      // Write the attribute to the staged data
+      addImg(resource.masterData.staged)
+
+      // Also write to published data is isStaged = false
+      // if isStaged is false we set the attribute on both the staged and
+      // published data.
+      if (!onlyStaged) {
+        addImg(resource.masterData.current)
+      }
+      checkForStagedChanges(resource)
+
+      return resource
+    },
+    removeImage: (
+      context: RepositoryContext,
+      resource: Writable<Product>,
+      { variantId, sku, imageUrl, staged }: ProductRemoveImageAction
+    ) => {
+      const removeImg = (data: Writable<ProductData>) => {
+        const { variant, isMasterVariant, variantIndex } = getVariant(
+          data,
+          variantId,
+          sku
+        )
+        if (!variant) {
+          throw new Error(
+            `Variant with id ${variantId} or sku ${sku} not found on product ${resource.id}`
+          )
+        }
+
+        const variantImages = variant.images ?? []
+        const existingImage = variantImages.find((x) => x.url === imageUrl)
+        if (!existingImage) {
+          throw new Error(
+            `Cannot remove image '${imageUrl}' because product '${resource.id}' does not have that image.`
+          )
+        }
+
+        // Remove image
+        variant.images = variantImages.filter((image) => image.url !== imageUrl)
+
+        if (isMasterVariant) {
+          data.masterVariant = variant
+        } else {
+          data.variants[variantIndex] = variant
+        }
+      }
+
+      // If true, only the staged Attribute is set. If false, both current and
+      // staged Attribute is set.  Default is true
+      const onlyStaged = staged !== undefined ? staged : true
+
+      // Write the attribute to the staged data
+      removeImg(resource.masterData.staged)
+
+      // Also write to published data is isStaged = false
+      // if isStaged is false we set the attribute on both the staged and
+      // published data.
+      if (!onlyStaged) {
+        removeImg(resource.masterData.current)
+      }
+      checkForStagedChanges(resource)
+
+      return resource
+    },
+
     // 'changeName': () => {},
     // 'changeSlug': () => {},
     // 'addVariant': () => {},
@@ -203,9 +312,7 @@ export class ProductRepository extends AbstractResourceRepository {
     // 'setTaxCategory': () => {},
     // 'setSku': () => {},
     // 'setProductVariantKey': () => {},
-    // 'addExternalImage': () => {},
     // 'moveImageToPosition': () => {},
-    // 'removeImage': () => {},
     // 'setImageLabel': () => {},
     // 'addAsset': () => {},
     // 'removeAsset': () => {},

package/src/repositories/project.ts

@@ -5,7 +5,7 @@ import {
   ProjectChangeCountryTaxRateFallbackEnabledAction,
   ProjectChangeCurrenciesAction,
   ProjectChangeLanguagesAction,
-  ProjectChangeMessagesEnabledAction,
+  ProjectChangeMessagesConfigurationAction,
   ProjectChangeNameAction,
   ProjectChangeOrderSearchStatusAction,
   ProjectChangeProductSearchIndexingEnabledAction,
@@ -13,17 +13,17 @@ import {
   ProjectSetShippingRateInputTypeAction,
   ProjectUpdateAction,
 } from '@commercetools/platform-sdk'
-import { Resource, Writable } from 'types'
-import { AbstractRepository, RepositoryContext } from './abstract'
 import { maskSecretValue } from '../lib/masking'
+import { Writable } from '../types'
+import { AbstractRepository, RepositoryContext } from './abstract'
 
-export class ProjectRepository extends AbstractRepository {
+export class ProjectRepository extends AbstractRepository<Project> {
   get(context: RepositoryContext): Project | null {
     const resource = this._storage.getProject(context.projectKey)
     return this.postProcessResource(resource)
   }
 
-  postProcessResource<T extends Resource>(resource: T): T {
+  postProcessResource(resource: Project): Project {
     if (resource) {
       return maskSecretValue(resource, 'externalOAuth.authorizationHeader')
     }
@@ -77,12 +77,13 @@ export class ProjectRepository extends AbstractRepository {
     ) => {
       resource.languages = languages
     },
-    changeMessagesEnabled: (
+    changeMessagesConfiguration: (
       context: RepositoryContext,
       resource: Writable<Project>,
-      { messagesEnabled }: ProjectChangeMessagesEnabledAction
+      { messagesConfiguration }: ProjectChangeMessagesConfigurationAction
     ) => {
-      resource.messages.enabled = messagesEnabled
+      resource.messages.enabled = messagesConfiguration.enabled
+      resource.messages.deleteDaysAfterCreation = messagesConfiguration.deleteDaysAfterCreation
     },
     changeProductSearchIndexingEnabled: (
       context: RepositoryContext,

package/src/repositories/quote-request.ts

@@ -0,0 +1,28 @@
+import {
+  QuoteRequest,
+  QuoteRequestDraft,
+  QuoteRequestUpdateAction,
+} from '@commercetools/platform-sdk'
+import { Writable } from '../types'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+
+export class QuoteRequestRepository extends AbstractResourceRepository<'quote-request'> {
+  getTypeId() {
+    return 'quote-request' as const
+  }
+
+  create(context: RepositoryContext, draft: QuoteRequestDraft): QuoteRequest {
+    throw new Error('not implemented')
+  }
+
+  actions: Partial<
+    Record<
+      QuoteRequestUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<QuoteRequest>,
+        action: any
+      ) => void
+    >
+  > = {}
+}

package/src/repositories/quote.ts

@@ -0,0 +1,28 @@
+import {
+  Quote,
+  QuoteDraft,
+  QuoteUpdateAction,
+} from '@commercetools/platform-sdk'
+import { Writable } from '../types'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+
+export class QuoteRepository extends AbstractResourceRepository<'quote'> {
+  getTypeId() {
+    return 'quote' as const
+  }
+
+  create(context: RepositoryContext, draft: QuoteDraft): Quote {
+    throw new Error('not implemented')
+  }
+
+  actions: Partial<
+    Record<
+      QuoteUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<Quote>,
+        action: any
+      ) => void
+    >
+  > = {}
+}

package/src/repositories/review.ts

@@ -0,0 +1,34 @@
+import {
+  Review,
+  ReviewDraft,
+  ReviewUpdateAction,
+} from '@commercetools/platform-sdk'
+import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+
+export class ReviewRepository extends AbstractResourceRepository<'review'> {
+  getTypeId() {
+    return 'review' as const
+  }
+
+  create(context: RepositoryContext, draft: ReviewDraft): Review {
+    const resource: Review = {
+      ...getBaseResourceProperties(),
+      includedInStatistics: false,
+    }
+    this.saveNew(context, resource)
+    return resource
+  }
+
+  actions: Partial<
+    Record<
+      ReviewUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<Review>,
+        action: any
+      ) => void
+    >
+  > = {}
+}

package/src/repositories/shipping-method.ts

@@ -1,10 +1,4 @@
 import {
-  createCustomFields,
-  createTypedMoney,
-  getReferenceFromResourceIdentifier,
-} from './helpers'
-import {
-  ReferenceTypeId,
   ShippingMethod,
   ShippingMethodAddShippingRateAction,
   ShippingMethodAddZoneAction,
@@ -25,14 +19,19 @@ import {
   ZoneRateDraft,
   ZoneReference,
 } from '@commercetools/platform-sdk'
+import deepEqual from 'deep-equal'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { Writable } from 'types'
-import deepEqual from 'deep-equal'
+import {
+  createCustomFields,
+  createTypedMoney,
+  getReferenceFromResourceIdentifier,
+} from './helpers'
 
-export class ShippingMethodRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'shipping-method'
+export class ShippingMethodRepository extends AbstractResourceRepository<'shipping-method'> {
+  getTypeId() {
+    return 'shipping-method' as const
   }
 
   create(

package/src/repositories/shopping-list.ts

@@ -1,6 +1,5 @@
 import {
   CustomerReference,
-  ReferenceTypeId,
   ShoppingList,
   ShoppingListDraft,
 } from '@commercetools/platform-sdk'
@@ -11,10 +10,11 @@ import {
   getReferenceFromResourceIdentifier,
 } from './helpers'
 
-export class ShoppingListRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'shopping-list'
+export class ShoppingListRepository extends AbstractResourceRepository<'shopping-list'> {
+  getTypeId() {
+    return 'shopping-list' as const
   }
+
   create(context: RepositoryContext, draft: ShoppingListDraft): ShoppingList {
     // const product =
 

package/src/repositories/staged-quote.ts

@@ -0,0 +1,29 @@
+import {
+  Quote,
+  StagedQuote,
+  StagedQuoteDraft,
+  StagedQuoteUpdateAction,
+} from '@commercetools/platform-sdk'
+import { Writable } from '../types'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+
+export class StagedQuoteRepository extends AbstractResourceRepository<'staged-quote'> {
+  getTypeId() {
+    return 'staged-quote' as const
+  }
+
+  create(context: RepositoryContext, draft: StagedQuoteDraft): StagedQuote {
+    throw new Error('not implemented')
+  }
+
+  actions: Partial<
+    Record<
+      StagedQuoteUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<Quote>,
+        action: any
+      ) => void
+    >
+  > = {}
+}

package/src/repositories/standalone-price.ts

@@ -0,0 +1,36 @@
+import {
+  Review,
+  StandalonePrice,
+  StandalonePriceUpdateAction,
+} from '@commercetools/platform-sdk'
+import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
+import { AbstractResourceRepository, RepositoryContext } from './abstract'
+
+export class StandAlonePriceRepository extends AbstractResourceRepository<'standalone-price'> {
+  getTypeId() {
+    return 'standalone-price' as const
+  }
+
+  create(context: RepositoryContext, draft: StandalonePrice): StandalonePrice {
+    const resource: StandalonePrice = {
+      ...getBaseResourceProperties(),
+      active: draft.active,
+      sku: draft.sku,
+      value: draft.value,
+    }
+    this.saveNew(context, resource)
+    return resource
+  }
+
+  actions: Partial<
+    Record<
+      StandalonePriceUpdateAction['action'],
+      (
+        context: RepositoryContext,
+        resource: Writable<Review>,
+        action: any
+      ) => void
+    >
+  > = {}
+}

package/src/repositories/state.ts

@@ -1,23 +1,23 @@
-import { getBaseResourceProperties } from '../helpers'
-import { getReferenceFromResourceIdentifier } from './helpers'
 import {
-  ReferenceTypeId,
-  StateReference,
   State,
+  StateChangeInitialAction,
   StateChangeKeyAction,
   StateDraft,
+  StateReference,
   StateSetDescriptionAction,
   StateSetNameAction,
   StateSetRolesAction,
   StateSetTransitionsAction,
   StateUpdateAction,
 } from '@commercetools/platform-sdk'
+import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { Writable } from 'types'
+import { getReferenceFromResourceIdentifier } from './helpers'
 
-export class StateRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'state'
+export class StateRepository extends AbstractResourceRepository<'state'> {
+  getTypeId() {
+    return 'state' as const
   }
 
   create(context: RepositoryContext, draft: StateDraft): State {
@@ -52,6 +52,13 @@ export class StateRepository extends AbstractResourceRepository {
     ) => {
       resource.key = key
     },
+    changeInitial: (
+      context: RepositoryContext,
+      resource: Writable<State>,
+      {initial }: StateChangeInitialAction
+    ) => {
+      resource.initial = initial
+    },
     setDescription: (
       context: RepositoryContext,
       resource: Writable<State>,

package/src/repositories/store.ts

@@ -1,27 +1,26 @@
 import {
-  Store,
-  StoreDraft,
-  ReferenceTypeId,
-  StoreUpdateAction,
-  StoreSetNameAction,
   ChannelReference,
-  StoreSetDistributionChannelsAction,
   ChannelResourceIdentifier,
-  StoreSetLanguagesAction,
+  Store,
+  StoreDraft,
   StoreSetCustomFieldAction,
   StoreSetCustomTypeAction,
+  StoreSetDistributionChannelsAction,
+  StoreSetLanguagesAction,
+  StoreSetNameAction,
+  StoreUpdateAction,
 } from '@commercetools/platform-sdk'
-import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 import {
-  getReferenceFromResourceIdentifier,
   createCustomFields,
+  getReferenceFromResourceIdentifier,
 } from './helpers'
 
-export class StoreRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'store'
+export class StoreRepository extends AbstractResourceRepository<'store'> {
+  getTypeId() {
+    return 'store' as const
   }
 
   create(context: RepositoryContext, draft: StoreDraft): Store {
@@ -61,21 +60,6 @@ export class StoreRepository extends AbstractResourceRepository {
     )
   }
 
-  getWithKey(context: RepositoryContext, key: string): Store | undefined {
-    const result = this._storage.query(context.projectKey, this.getTypeId(), {
-      where: [`key="${key}"`],
-    })
-    if (result.count === 1) {
-      return result.results[0] as Store
-    }
-
-    if (result.count > 1) {
-      throw new Error('Duplicate store key')
-    }
-
-    return
-  }
-
   actions: Partial<
     Record<
       StoreUpdateAction['action'],

package/src/repositories/subscription.ts

@@ -1,6 +1,5 @@
 import {
   InvalidInputError,
-  ReferenceTypeId,
   Subscription,
   SubscriptionDraft,
 } from '@commercetools/platform-sdk'
@@ -8,9 +7,9 @@ import { CommercetoolsError } from '../exceptions'
 import { getBaseResourceProperties } from '../helpers'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 
-export class SubscriptionRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'subscription'
+export class SubscriptionRepository extends AbstractResourceRepository<'subscription'> {
+  getTypeId() {
+    return 'subscription' as const
   }
   create(context: RepositoryContext, draft: SubscriptionDraft): Subscription {
     // TODO: We could actually test this here by using the aws sdk. For now

package/src/repositories/tax-category.ts

@@ -1,5 +1,4 @@
 import {
-  ReferenceTypeId,
   TaxCategory,
   TaxCategoryAddTaxRateAction,
   TaxCategoryChangeNameAction,
@@ -12,14 +11,14 @@ import {
   TaxRate,
   TaxRateDraft,
 } from '@commercetools/platform-sdk'
+import { v4 as uuidv4 } from 'uuid'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
-import { v4 as uuidv4 } from 'uuid'
-import { Writable } from 'types'
 
-export class TaxCategoryRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'tax-category'
+export class TaxCategoryRepository extends AbstractResourceRepository<'tax-category'> {
+  getTypeId() {
+    return 'tax-category' as const
   }
 
   create(context: RepositoryContext, draft: TaxCategoryDraft): TaxCategory {
@@ -38,22 +37,6 @@ export class TaxCategoryRepository extends AbstractResourceRepository {
     amount: draft.amount || 0,
   })
 
-  getWithKey(context: RepositoryContext, key: string): TaxCategory | undefined {
-    const result = this._storage.query(context.projectKey, this.getTypeId(), {
-      where: [`key="${key}"`],
-    })
-    if (result.count === 1) {
-      return result.results[0] as TaxCategory
-    }
-
-    // Catch this for now, should be checked when creating/updating
-    if (result.count > 1) {
-      throw new Error('Duplicate tax category key')
-    }
-
-    return
-  }
-
   actions: Partial<
     Record<
       TaxCategoryUpdateAction['action'],

package/src/repositories/type.ts

@@ -1,27 +1,26 @@
 import {
-  Type,
-  TypeDraft,
-  InvalidOperationError,
-  ReferenceTypeId,
-  TypeUpdateAction,
   FieldDefinition,
-  TypeSetDescriptionAction,
-  TypeChangeNameAction,
+  InvalidOperationError,
+  Type,
+  TypeAddEnumValueAction,
   TypeAddFieldDefinitionAction,
   TypeChangeEnumValueLabelAction,
-  TypeAddEnumValueAction,
   TypeChangeFieldDefinitionOrderAction,
+  TypeChangeNameAction,
+  TypeDraft,
   TypeRemoveFieldDefinitionAction,
+  TypeSetDescriptionAction,
+  TypeUpdateAction,
 } from '@commercetools/platform-sdk'
-import { CommercetoolsError } from '../exceptions'
 import { isEqual } from 'lodash'
-import { Writable } from 'types'
+import { CommercetoolsError } from '../exceptions'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 
-export class TypeRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'type'
+export class TypeRepository extends AbstractResourceRepository<'type'> {
+  getTypeId() {
+    return 'type' as const
   }
 
   create(context: RepositoryContext, draft: TypeDraft): Type {

package/src/repositories/zone.ts

@@ -1,5 +1,4 @@
 import {
-  ReferenceTypeId,
   Zone,
   ZoneAddLocationAction,
   ZoneChangeNameAction,
@@ -9,13 +8,13 @@ import {
   ZoneSetKeyAction,
   ZoneUpdateAction,
 } from '@commercetools/platform-sdk'
-import { Writable } from 'types'
 import { getBaseResourceProperties } from '../helpers'
+import { Writable } from '../types'
 import { AbstractResourceRepository, RepositoryContext } from './abstract'
 
-export class ZoneRepository extends AbstractResourceRepository {
-  getTypeId(): ReferenceTypeId {
-    return 'zone'
+export class ZoneRepository extends AbstractResourceRepository<'zone'> {
+  getTypeId() {
+    return 'zone' as const
   }
 
   create(context: RepositoryContext, draft: ZoneDraft): Zone {