Image test data model migration (#943)

* feat(product): add image-dimensions model

* chore: add changeset

* refactor(product): migrate image model to the new implementation patterns

* refactor(product): adjust imports

* chore: add changeset

* fix: adjust changeset

* fix(image): adjust tests names

* refactor(image): update js docs

Author: CarlosCortizasCT

.changeset/pretty-rats-peel.md

@@ -0,0 +1,17 @@
+---
+'@commercetools/composable-commerce-test-data': patch
+---
+
+We've migrated the `Image` model to the new implementation patterns.
+
+This change does not have any impact on consumers, however the `Image` model is now deprecated and you're expected to start using the `ImageGraphql` or `ImageRest` models instead depending of the type of API you're mocking.
+
+```ts
+import {
+  ImageGraphql,
+  ImageRest,
+} from '@commercetools/composable-commerce-test-data/product';
+
+const graphqlImage = ImageGraphql.random().build();
+const restImage = ImageRest.random().build();
+```

docs/guidelines/writing-changesets.md

@@ -81,7 +81,10 @@ We've migrated the `TaxRate` model to the new implementation patterns.
 This change does not have any impact on consumers, however the `TaxRate` model is now deprecated and you're expected to start using the `TaxRateGraphql` or `TaxRateRest` models instead depending of the type of API you're mocking.
 
 ```ts
-import { TaxRateGraphql, TaxRateRest } form '@commercetools/composable-commerce-test-data/tax-cateopry';
+import {
+  TaxRateGraphql,
+  TaxRateRest,
+} from '@commercetools/composable-commerce-test-data/tax-cateopry';
 
 const graphqlTaxRate = TaxRateGraphql.random().build();
 const restTaxRate = TaxRateRest.random().build();

standalone/src/models/product/product/image/builder.spec.ts

@@ -0,0 +1,63 @@
+import { TImage, TImageGraphql, TImageRest } from './types';
+import { Image, ImageGraphql, ImageRest } from './index';
+
+const validateModel = (model: TImageGraphql | TImageRest) => {
+  expect(model).toMatchObject({
+    label: expect.any(String),
+    url: expect.any(String),
+  });
+};
+
+const validateRestModel = (model: TImageRest | TImage) => {
+  validateModel(model);
+  expect(model.dimensions).toEqual(
+    expect.objectContaining({
+      w: expect.any(Number),
+      h: expect.any(Number),
+    })
+  );
+};
+
+const validateGraphqlModel = (model: TImageGraphql) => {
+  validateModel(model);
+  expect(model.dimensions).toEqual(
+    expect.objectContaining({
+      __typename: 'Dimensions',
+    })
+  );
+  expect(model.__typename).toEqual('Image');
+};
+
+describe('Image model builders', () => {
+  it('builds a REST model', () => {
+    const restModel = ImageRest.random().build();
+
+    validateRestModel(restModel);
+  });
+
+  it('builds a GraphQL model', () => {
+    const graphqlModel = ImageGraphql.random().build();
+
+    validateGraphqlModel(graphqlModel);
+  });
+});
+
+describe('Image model compatibility builders', () => {
+  it('builds a default (REST) model', () => {
+    const restModel = Image.random().build<TImage>();
+
+    validateRestModel(restModel);
+  });
+
+  it('builds a REST model', () => {
+    const restModel = Image.random().buildRest<TImageRest>();
+
+    validateRestModel(restModel);
+  });
+
+  it('builds a GraphQL model', () => {
+    const graphqlModel = Image.random().buildGraphql<TImageGraphql>();
+
+    validateGraphqlModel(graphqlModel);
+  });
+});

standalone/src/models/product/product/image/builder.ts

@@ -0,0 +1,32 @@
+import {
+  createCompatibilityBuilder,
+  createSpecializedBuilder,
+  type TModelFieldsConfig,
+} from '@/core';
+import { restFieldsConfig, graphqlFieldsConfig } from './fields-config';
+import { TImageGraphql, TImageRest, TCreateImageBuilder } from './types';
+
+export const RestModelBuilder: TCreateImageBuilder<TImageRest> = () =>
+  createSpecializedBuilder({
+    name: 'ImageRestBuilder',
+    type: 'rest',
+    modelFieldsConfig: restFieldsConfig,
+  });
+
+export const GraphqlModelBuilder: TCreateImageBuilder<TImageGraphql> = () =>
+  createSpecializedBuilder({
+    name: 'ImageGraphqlBuilder',
+    type: 'graphql',
+    modelFieldsConfig: graphqlFieldsConfig,
+  });
+
+export const CompatModelBuilder = <
+  TImageModel extends TImageRest | TImageGraphql,
+>() =>
+  createCompatibilityBuilder({
+    name: 'CompatImageModelBuilder',
+    modelFieldsConfig: {
+      rest: restFieldsConfig as TModelFieldsConfig<TImageModel>,
+      graphql: graphqlFieldsConfig as TModelFieldsConfig<TImageModel>,
+    },
+  });

standalone/src/models/product/product/image/builders.spec.ts

@@ -0,0 +1,39 @@
+import { fake, TModelFieldsConfig } from '@/core';
+import {
+  ImageDimensionsGraphql,
+  ImageDimensionsRest,
+} from '../image-dimensions';
+import { TImageGraphql, TImageRest } from './types';
+
+const commonFieldsConfig = {
+  label: fake((f) => f.lorem.slug(2)),
+  url: fake((f) => f.image.url()),
+};
+
+export const restFieldsConfig: TModelFieldsConfig<TImageRest> = {
+  fields: {
+    ...commonFieldsConfig,
+    dimensions: fake(() => ImageDimensionsRest.random()),
+  },
+};
+
+export const graphqlFieldsConfig: TModelFieldsConfig<TImageGraphql> = {
+  fields: {
+    ...commonFieldsConfig,
+    dimensions: fake(() => ImageDimensionsGraphql.random()),
+    __typename: 'Image',
+  },
+  postBuild: (model, context) => {
+    if (context?.isCompatMode) {
+      model.dimensions = model.dimensions
+        ? ImageDimensionsGraphql.random()
+            // @ts-expect-error - This is needed because of the compatibility mode using the REST API
+            .width(model.dimensions.w)
+            // @ts-expect-error - This is needed because of the compatibility mode using the REST API
+            .height(model.dimensions.h)
+            .build()
+        : model.dimensions;
+    }
+    return model;
+  },
+};