[FEC-88] Migrating test data model Inventory Entry

.changeset/metal-mice-sit.md

@@ -0,0 +1,10 @@
+---
+'@commercetools-test-data/inventory-entry': minor
+---
+
+Refactored `InventoryEntry` and `InventoryEntryDraft` models to use the new implementation patterns.
+This means the existing models are now deprecated (though we still support them for backwards compatibility) and consumers should move to the new ones implemented:
+* `InventoryEntryRest`
+* `InventoryEntryGraphql`
+* `InventoryEntryDraftRest`
+* `InventoryEntryDraftGraphql`

models/channel/README.md

@@ -12,6 +12,33 @@ $ pnpm add -D @commercetools-test-data/channel
 
 # Usage
 
+```ts
+import {
+  ChannelRest,
+  ChannelDraftRest,
+  ChannelGraphql,
+  ChannelDraftGraphql,
+} from '@commercetools-test-data/inventory-entry';
+
+const channelRest = ChannelRest.random().build();
+const channelDraftRest = ChannelDraftRest.random().build();
+
+const channelGraphql = ChannelGraphql.random().build();
+const channelDraftGraphql = ChannelDraftGraphql.random().build();
+
+// Presets
+const withInventorySupplyAndProductDistributionRolesRest =
+  ChannelDraftRest.presets
+    .withInventorySupplyAndProductDistributionRoles()
+    .build();
+const withInventorySupplyAndProductDistributionRolesGraphql =
+  ChannelDraftGraphql.presets
+    .withInventorySupplyAndProductDistributionRoles()
+    .build();
+```
+
+For backwards compatibility, we still support using the generic data models, but you should consider them legacy as we will be removing them in the future.
+
 ```ts
 import {
   Channel,

models/inventory-entry/README.md

@@ -12,6 +12,23 @@ $ yarn add -D @commercetools-test-data/inventory-entry
 
 # Usage
 
+```ts
+import {
+  InventoryEntryRest,
+  InventoryEntryDraftRest,
+  InventoryEntryGraphql,
+  InventoryEntryDraftGraphql,
+} from '@commercetools-test-data/inventory-entry';
+
+const inventoryEntryRest = InventoryEntryRest.random().build();
+const inventoryEntryDraftRest = InventoryEntryDraftRest.random().build();
+
+const inventoryEntryGraphql = InventoryEntryGraphql.random().build();
+const inventoryEntryDraftGraphql = InventoryEntryDraftGraphql.random().build();
+```
+
+For backwards compatibility, we still support using the generic data models, but you should consider them legacy as we will be removing them in the future.
+
 ```ts
 import type {
   TInventoryEntry,

models/inventory-entry/src/builders.spec.ts

@@ -0,0 +1,114 @@
+import {
+  InventoryEntry,
+  InventoryEntryRest,
+  InventoryEntryGraphql,
+} from './index';
+
+describe('InventoryEntry model builders', () => {
+  it('builds a REST model', () => {
+    const restModel = InventoryEntryRest.random().build();
+
+    expect(restModel).toEqual(
+      expect.objectContaining({
+        id: expect.any(String),
+        key: expect.any(String),
+        version: expect.any(Number),
+        createdAt: expect.any(String),
+        createdBy: expect.any(Object),
+        lastModifiedAt: expect.any(String),
+        lastModifiedBy: expect.any(Object),
+        sku: expect.any(String),
+        quantityOnStock: expect.any(Number),
+        restockableInDays: expect.any(Number),
+        availableQuantity: expect.any(Number),
+        expectedDelivery: expect.any(String),
+        supplyChannel: expect.any(Object),
+        custom: null,
+      })
+    );
+  });
+
+  it('builds a GraphQL model', () => {
+    const graphqlModel = InventoryEntryGraphql.random().build();
+
+    expect(graphqlModel).toMatchObject(
+      expect.objectContaining({
+        id: expect.any(String),
+        key: expect.any(String),
+        version: expect.any(Number),
+        createdAt: expect.any(String),
+        createdBy: expect.any(Object),
+        lastModifiedAt: expect.any(String),
+        lastModifiedBy: expect.any(Object),
+        sku: expect.any(String),
+        quantityOnStock: expect.any(Number),
+        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',
+        }),
+        custom: null,
+        __typename: 'InventoryEntry',
+      })
+    );
+  });
+});
+
+describe('InventoryEntry model compatibility builders', () => {
+  it('builds a REST model', () => {
+    const restModel = InventoryEntry.random().buildRest();
+
+    expect(restModel).toEqual(
+      expect.objectContaining({
+        id: expect.any(String),
+        key: expect.any(String),
+        version: expect.any(Number),
+        createdAt: expect.any(String),
+        createdBy: expect.any(Object),
+        lastModifiedAt: expect.any(String),
+        lastModifiedBy: expect.any(Object),
+        sku: expect.any(String),
+        quantityOnStock: expect.any(Number),
+        restockableInDays: expect.any(Number),
+        availableQuantity: expect.any(Number),
+        expectedDelivery: expect.any(String),
+        supplyChannel: expect.any(Object),
+        custom: null,
+      })
+    );
+  });
+
+  it('builds a GraphQL model', () => {
+    const graphqlModel = InventoryEntry.random().buildGraphql();
+
+    expect(graphqlModel).toMatchObject(
+      expect.objectContaining({
+        id: expect.any(String),
+        key: expect.any(String),
+        version: expect.any(Number),
+        createdAt: expect.any(String),
+        createdBy: expect.any(Object),
+        lastModifiedAt: expect.any(String),
+        lastModifiedBy: expect.any(Object),
+        sku: expect.any(String),
+        availableQuantity: expect.any(Number),
+        quantityOnStock: expect.any(Number),
+        restockableInDays: expect.any(Number),
+        expectedDelivery: expect.any(String),
+        supplyChannel: expect.objectContaining({
+          __typename: 'Channel',
+        }),
+        custom: null,
+      })
+    );
+  });
+});

models/inventory-entry/src/builders.ts

@@ -0,0 +1,42 @@
+import {
+  createCompatibilityBuilder,
+  createSpecializedBuilder,
+  TModelFieldsConfig,
+} from '@commercetools-test-data/core';
+import { restFieldsConfig, graphqlFieldsConfig } from './fields-config';
+import type {
+  TCreateInventoryEntryBuilder,
+  TInventoryEntryRest,
+  TInventoryEntryGraphql,
+} from './types';
+
+export const RestModelBuilder: TCreateInventoryEntryBuilder<
+  TInventoryEntryRest
+> = () =>
+  createSpecializedBuilder({
+    name: 'InventoryEntryRestBuilder',
+    type: 'rest',
+    modelFieldsConfig: restFieldsConfig,
+  });
+
+export const GraphqlModelBuilder: TCreateInventoryEntryBuilder<
+  TInventoryEntryGraphql
+> = () =>
+  createSpecializedBuilder({
+    name: 'InventoryEntryGraphqlBuilder',
+    type: 'graphql',
+    modelFieldsConfig: graphqlFieldsConfig,
+  });
+
+export const CompatInventoryEntryModelBuilder = <
+  TInventoryEntryModel extends
+    | TInventoryEntryRest
+    | TInventoryEntryGraphql = TInventoryEntryRest,
+>() =>
+  createCompatibilityBuilder<TInventoryEntryModel>({
+    name: 'InventoryEntryCompatBuilder',
+    modelFieldsConfig: {
+      rest: restFieldsConfig as TModelFieldsConfig<TInventoryEntryModel>,
+      graphql: graphqlFieldsConfig as TModelFieldsConfig<TInventoryEntryModel>,
+    },
+  });

models/inventory-entry/src/fields-config.ts

@@ -0,0 +1,56 @@
+import { ChannelGraphql } from '@commercetools-test-data/channel';
+import {
+  ClientLogging,
+  Reference,
+  TReferenceGraphql,
+} from '@commercetools-test-data/commons';
+import {
+  fake,
+  sequence,
+  type TModelFieldsConfig,
+} from '@commercetools-test-data/core';
+import { createRelatedDates } from '@commercetools-test-data/utils';
+import type { TInventoryEntryGraphql, TInventoryEntryRest } from './types';
+
+const [getOlderDate, getNewerDate, getFutureDate] = createRelatedDates();
+
+const commonFieldsConfig = {
+  id: fake((f) => f.string.uuid()),
+  version: sequence(),
+  createdAt: fake(getOlderDate),
+  createdBy: fake(() => ClientLogging.random()),
+  lastModifiedAt: fake(getNewerDate),
+  lastModifiedBy: fake(() => ClientLogging.random()),
+  key: fake((f) => f.lorem.slug(2)),
+  sku: fake((f) => f.lorem.words()),
+  quantityOnStock: fake((f) => f.number.int()),
+  availableQuantity: fake((f) => f.number.int()),
+  restockableInDays: fake((f) => f.number.int()),
+  expectedDelivery: fake(getFutureDate),
+  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()),
+  },
+  postBuild: (model) => {
+    const supplyChannelRef = model.supplyChannel
+      ? Reference.presets
+          .channelReference()
+          .id(model.supplyChannel.id)
+          .buildGraphql<TReferenceGraphql<'channel'>>()
+      : null;
+    return {
+      supplyChannelRef,
+    };
+  },
+};