FEC-39: Fix models related to Batch 2 (Part 1) (#650)

* feat: add discounted price type in commons model * fix: make supply channel optional in inventory-entry * chore: add enum lenum presets and total in transformer * chore: changeset * fix: lint issue * refactor(discounted-price): adjust graphql types * refactor(inventory-entry): adjust graphql types * refactor(reference): adjust graphql types * refactor(inventory-entry): supply channel is optional * fix(inventory-entry): adjust tests --------- Co-authored-by: Carlos Cortizas <[email protected]>
commercetools · Dec 5, 2024 · 8038c61 · 8038c61
1 parent 33a191d
commit 8038c61
Show file tree

Hide file tree

Showing 23 changed files with 200 additions and 71 deletions.
diff --git a/.changeset/thick-experts-thank.md b/.changeset/thick-experts-thank.md
@@ -0,0 +1,17 @@
+---
+'@commercetools-test-data/product-type': minor
+'@commercetools-test-data/commons': minor
+'@commercetools-test-data/inventory-entry': patch
+---
+
+### Common Model (`common`)
+
+- Introduced a new model called `discounted-price`.
+
+### Inventory Entry Model (`inventory-entry`)
+
+- Updated the transformer file to conditionally send the supply channel, making it optional.
+
+### Product Type (`product-type`)
+
+- Added new presets for enum and localized enum types.
diff --git a/graphql-types/src/generated/core.ts b/graphql-types/src/generated/core.ts
diff --git a/graphql-types/src/generated/ctp.ts b/graphql-types/src/generated/ctp.ts
diff --git a/graphql-types/src/generated/mc.ts b/graphql-types/src/generated/mc.ts
diff --git a/graphql-types/src/generated/settings.ts b/graphql-types/src/generated/settings.ts
diff --git a/models/commons/src/discounted-price/builders.spec.ts b/models/commons/src/discounted-price/builders.spec.ts
@@ -34,7 +34,7 @@ describe('DiscountedPrice Builder', () => {
           __typename: 'ProductDiscount',
         }),
         discountRef: expect.objectContaining({
-          id: expect.any(String),
+          id: graphqlModel.discount?.id,
           typeId: 'product-discount',
           __typename: 'Reference',
         }),

diff --git a/models/commons/src/discounted-price/discounted-price-draft/builders.spec.ts b/models/commons/src/discounted-price/discounted-price-draft/builders.spec.ts
@@ -23,7 +23,6 @@ describe('DiscountedPriceDraft Builder', () => {
 
     expect(graphqlDraftModel).toEqual(
       expect.objectContaining({
-        __typename: 'DiscountedProductPriceValue',
         value: expect.objectContaining({
           centAmount: expect.any(Number),
           currencyCode: expect.any(String),

diff --git a/models/commons/src/discounted-price/discounted-price-draft/fields-config.ts b/models/commons/src/discounted-price/discounted-price-draft/fields-config.ts
@@ -26,6 +26,5 @@ export const graphqlFieldsConfig: TModelFieldsConfig<TDiscountedPriceDraftGraphq
   {
     fields: {
       ...commonFieldsConfig,
-      __typename: 'DiscountedProductPriceValue',
     },
   };
diff --git a/models/commons/src/discounted-price/fields-config.ts b/models/commons/src/discounted-price/fields-config.ts
@@ -31,4 +31,14 @@ export const graphqlFieldsConfig: TModelFieldsConfig<TDiscountedPriceGraphql> =
       discount: fake(() => ProductDiscount.random()),
       discountRef: fake(() => Reference.presets.productDiscountReference()),
     },
+    postBuild: (model) => {
+      if (model.discount) {
+        model.discountRef = Reference.presets
+          .productDiscountReference()
+          .id(model.discount.id)
+          .buildGraphql();
+      }
+
+      return model;
+    },
   };
diff --git a/models/commons/src/discounted-price/types.ts b/models/commons/src/discounted-price/types.ts
@@ -3,25 +3,17 @@ import {
   DiscountedPriceDraft,
 } from '@commercetools/platform-sdk';
 import type { TBuilder } from '@commercetools-test-data/core';
-import { TProductDiscountGraphql } from '@commercetools-test-data/product-discount';
-import { TReferenceGraphql, TReferenceDraftGraphql } from '../reference/types';
+import type {
+  TCtpDiscountedProductPriceValue,
+  TCtpDiscountedProductPriceValueInput,
+} from '@commercetools-test-data/graphql-types';
 
 export type TDiscountedPriceRest = DiscountedPrice;
 
-export type TDiscountedPriceGraphql = Omit<TDiscountedPriceRest, 'discount'> & {
-  __typename: 'DiscountedProductPriceValue';
-  discount: TProductDiscountGraphql;
-  discountRef: TReferenceGraphql<'product-discount'>;
-};
+export type TDiscountedPriceGraphql = TCtpDiscountedProductPriceValue;
 
 export type TDiscountedPriceDraftRest = DiscountedPriceDraft;
-export type TDiscountedPriceDraftGraphql = Omit<
-  DiscountedPriceDraft,
-  'discount'
-> & {
-  __typename: 'DiscountedProductPriceValue';
-  discount: TReferenceDraftGraphql<'product-discount'>;
-};
+export type TDiscountedPriceDraftGraphql = TCtpDiscountedProductPriceValueInput;
 
 export type TCreateDiscountedPriceBuilder<
   TModel extends

diff --git a/models/commons/src/reference/types.ts b/models/commons/src/reference/types.ts
@@ -1,4 +1,5 @@
 import type { TBuilder } from '@commercetools-test-data/core';
+import { TCtpReference } from '@commercetools-test-data/graphql-types';
 
 export type TReferenceBuilder<TypeId = string> = TBuilder<TReference<TypeId>>;
 
@@ -17,15 +18,18 @@ export type TCreateReferenceBuilder<TypeId = string> =
 
 export type TReferenceRest<
   TypeId = string,
-  ExpandedObject extends TExpandedReferenceObject<TypeId> = TExpandedReferenceObject<TypeId>
+  ExpandedObject extends
+    TExpandedReferenceObject<TypeId> = TExpandedReferenceObject<TypeId>,
 > = TReference<TypeId> & {
   obj: ExpandedObject;
 };
 
-export type TReferenceGraphql<TypeId = string> =
-  TExpandedReferenceObject<TypeId> & {
-    __typename: 'Reference';
-  };
+export type TReferenceGraphql<TypeId = string> = Omit<
+  TCtpReference,
+  'typeId'
+> & {
+  typeId: TypeId;
+};
 
 // Draft representation
 export interface TReferenceDraft<TypeId = string> {

diff --git a/models/inventory-entry/package.json b/models/inventory-entry/package.json
@@ -22,6 +22,7 @@
     "@commercetools-test-data/channel": "10.10.1",
     "@commercetools-test-data/commons": "10.10.1",
     "@commercetools-test-data/core": "10.10.1",
+    "@commercetools-test-data/graphql-types": "10.10.1",
     "@commercetools-test-data/product": "10.10.1",
     "@commercetools-test-data/utils": "10.10.1",
     "@commercetools/platform-sdk": "7.14.0",

diff --git a/models/inventory-entry/src/builders.spec.ts b/models/inventory-entry/src/builders.spec.ts
@@ -22,7 +22,7 @@ describe('InventoryEntry model builders', () => {
         restockableInDays: expect.any(Number),
         availableQuantity: expect.any(Number),
         expectedDelivery: expect.any(String),
-        supplyChannel: expect.any(Object),
+        supplyChannel: null,
         custom: null,
       })
     );
@@ -45,17 +45,8 @@ describe('InventoryEntry model builders', () => {
         restockableInDays: expect.any(Number),
         availableQuantity: expect.any(Number),
         expectedDelivery: expect.any(String),
-        supplyChannel: expect.objectContaining({
-          __typename: 'Channel',
-          address: expect.objectContaining({
-            country: expect.any(String),
-          }),
-        }),
-        supplyChannelRef: expect.objectContaining({
-          __typename: 'Reference',
-          id: expect.any(String),
-          typeId: 'channel',
-        }),
+        supplyChannel: null,
+        supplyChannelRef: null,
         custom: null,
         __typename: 'InventoryEntry',
       })
@@ -81,7 +72,7 @@ describe('InventoryEntry model compatibility builders', () => {
         restockableInDays: expect.any(Number),
         availableQuantity: expect.any(Number),
         expectedDelivery: expect.any(String),
-        supplyChannel: expect.any(Object),
+        supplyChannel: null,
         custom: null,
       })
     );
@@ -104,9 +95,8 @@ describe('InventoryEntry model compatibility builders', () => {
         quantityOnStock: expect.any(Number),
         restockableInDays: expect.any(Number),
         expectedDelivery: expect.any(String),
-        supplyChannel: expect.objectContaining({
-          __typename: 'Channel',
-        }),
+        supplyChannel: null,
+        supplyChannelRef: null,
         custom: null,
       })
     );

diff --git a/models/inventory-entry/src/fields-config.ts b/models/inventory-entry/src/fields-config.ts
@@ -1,4 +1,3 @@
-import { ChannelGraphql } from '@commercetools-test-data/channel';
 import {
   ClientLogging,
   Reference,
@@ -27,20 +26,19 @@ const commonFieldsConfig = {
   availableQuantity: fake((f) => f.number.int()),
   restockableInDays: fake((f) => f.number.int()),
   expectedDelivery: fake(getFutureDate),
+  supplyChannel: null,
   custom: null,
 };
 export const restFieldsConfig: TModelFieldsConfig<TInventoryEntryRest> = {
   fields: {
     ...commonFieldsConfig,
-    supplyChannel: fake(() => Reference.presets.channelReference()),
   },
 };
 export const graphqlFieldsConfig: TModelFieldsConfig<TInventoryEntryGraphql> = {
   fields: {
     ...commonFieldsConfig,
     __typename: 'InventoryEntry',
-    supplyChannel: fake(() => ChannelGraphql.random()),
-    supplyChannelRef: fake((f) => Reference.presets.channelReference()),
+    supplyChannelRef: null,
   },
   postBuild: (model) => {
     const supplyChannelRef = model.supplyChannel

diff --git a/models/inventory-entry/src/types.ts b/models/inventory-entry/src/types.ts
@@ -2,28 +2,29 @@ import {
   InventoryEntry,
   InventoryEntryDraft,
 } from '@commercetools/platform-sdk';
-import { TChannelGraphql } from '@commercetools-test-data/channel';
-import type { TReferenceGraphql } from '@commercetools-test-data/commons';
 import type { TBuilder } from '@commercetools-test-data/core';
+import type {
+  TCtpInventoryEntry,
+  TCtpInventoryEntryDraft,
+} from '@commercetools-test-data/graphql-types';
 
 // Default
 /**
  * @deprecated use `TInventoryEntryRest` instead
  */
 export type TInventoryEntry = InventoryEntry;
+/**
+ * @deprecated use `TInventoryEntryDraftRest` instead
+ */
 export type TInventoryEntryDraft = InventoryEntryDraft;
 
 // REST
 export type TInventoryEntryRest = InventoryEntry;
 export type TInventoryEntryDraftRest = InventoryEntryDraft;
 
 // GraphQL
-export type TInventoryEntryGraphql = Omit<InventoryEntry, 'supplyChannel'> & {
-  __typename: 'InventoryEntry';
-  supplyChannel?: TChannelGraphql | null;
-  supplyChannelRef?: TReferenceGraphql<'channel'> | null;
-};
-export type TInventoryEntryDraftGraphql = TInventoryEntryDraft;
+export type TInventoryEntryGraphql = TCtpInventoryEntry;
+export type TInventoryEntryDraftGraphql = TCtpInventoryEntryDraft;
 
 export type TInventoryEntryBuilder = TBuilder<TInventoryEntry>;
 export type TInventoryEntryDraftBuilder = TBuilder<TInventoryEntryDraft>;

diff --git a/models/product-type/src/attribute-definition/presets/index.ts b/models/product-type/src/attribute-definition/presets/index.ts
@@ -1,3 +1,45 @@
-const presets = {};
+import { LocalizedString } from '@commercetools-test-data/commons';
+import {
+  AttributeEnumType,
+  AttributeNumberType,
+  AttributeTextType,
+} from '../..';
+import AttributeDefinition from '../builder';
+
+const presets = {
+  number: () =>
+    AttributeDefinition()
+      .type(AttributeNumberType.random())
+      .name('Number Attribute Definition')
+      .label(
+        LocalizedString.presets
+          .empty()
+          .en(`Number Attribute Definition's Label`)
+      )
+      .inputTip(
+        LocalizedString.presets
+          .empty()
+          .en(`Number Attribute Definition's Input Tip`)
+      ),
+
+  countryOfOrigin: () =>
+    AttributeDefinition()
+      .attributeConstraint('None')
+      .name('country-of-origin')
+      .label(LocalizedString.presets.empty().en('Country of Origin'))
+      .isRequired(true)
+      .type(AttributeTextType.random()),
+
+  size: () =>
+    AttributeDefinition()
+      .attributeConstraint('None')
+      .name('size')
+      .label(LocalizedString.presets.empty().en('Size'))
+      .inputTip(LocalizedString.presets.empty().en('Size of a product'))
+      .inputHint('SingleLine')
+      .isRequired(true)
+      .isSearchable(true)
+      .type(AttributeEnumType.presets.allSizesEnum()),
+};
 
 export default presets;
diff --git a/models/product-type/src/attribute-enum-type/presets/index.ts b/models/product-type/src/attribute-enum-type/presets/index.ts
@@ -1,3 +1,25 @@
-const presets = {};
+import { AttributePlainEnumValue } from '../..';
+import AttributeEnumType from '../builder';
+
+const presets = {
+  allSizesEnum: () =>
+    AttributeEnumType().values([
+      AttributePlainEnumValue.presets.s(),
+      AttributePlainEnumValue.presets.m(),
+      AttributePlainEnumValue.presets.l(),
+      AttributePlainEnumValue.presets.xl(),
+    ]),
+  smallSizesEnum: () =>
+    AttributeEnumType().values([
+      AttributePlainEnumValue.presets.s(),
+      AttributePlainEnumValue.presets.m(),
+    ]),
+
+  bigSizesEnum: () =>
+    AttributeEnumType().values([
+      AttributePlainEnumValue.presets.l(),
+      AttributePlainEnumValue.presets.xl(),
+    ]),
+};
 
 export default presets;