FCT-702: add Associate and Associate-Role-Assignment models

.changeset/polite-ladybugs-smile.md

@@ -0,0 +1,5 @@
+---
+'@commercetools-test-data/business-unit': minor
+---
+
+Add `Associate` and `AssociateRoleAssignment` models, adjust types and constants colocation.

models/business-unit/README.md

@@ -24,3 +24,12 @@ import { CompanyDraft, DivisionDraft, type TBusinessUnitDraft } from from '@comm
 const companyDraft = CompanyDraft.random().build<TBusinessUnitDraft>();
 const divisionDraft = DivisionDraft.random().build<TBusinessUnitDraft>();
 ```
+
+## Associate and AssociateRoleAssignment
+
+```ts
+import { Associate, AssociateRoleAssignment, type TAssociateDefault, type TAssociateRoleAssignmentDefault } from from '@commercetools-test-data/business-unit';
+
+const associate = Associate.random().build<TAssociateDefault>();
+const associateRoleAssignment = AssociateRoleAssignment.random().build<TAssociateRoleAssignmentDefault>();
+```

models/business-unit/package.json

@@ -19,6 +19,7 @@
   "dependencies": {
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
+    "@commercetools-test-data/associate-role": "7.0.0",
     "@commercetools-test-data/commons": "7.0.0",
     "@commercetools-test-data/core": "7.0.0",
     "@commercetools-test-data/utils": "7.0.0",

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/builder.spec.ts

@@ -0,0 +1,61 @@
+/* eslint-disable jest/no-disabled-tests */
+/* eslint-disable jest/valid-title */
+import { createBuilderSpec } from '@commercetools-test-data/core/test-utils';
+import {
+  TAssociateRoleAssignmentDraft,
+  TAssociateRoleAssignmentDraftGraphql,
+} from '../types';
+import * as AssociateRoleAssignmentDraft from '.';
+
+describe('builder', () => {
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDraft,
+      TAssociateRoleAssignmentDraft
+    >(
+      'default',
+      AssociateRoleAssignmentDraft.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          typeId: 'associate-role',
+          id: expect.any(String),
+        }),
+        inheritance: expect.any(String),
+      })
+    )
+  );
+
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDraft,
+      TAssociateRoleAssignmentDraft
+    >(
+      'rest',
+      AssociateRoleAssignmentDraft.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          typeId: 'associate-role',
+          id: expect.any(String),
+        }),
+        inheritance: expect.any(String),
+      })
+    )
+  );
+
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDraft,
+      TAssociateRoleAssignmentDraftGraphql
+    >(
+      'graphql',
+      AssociateRoleAssignmentDraft.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          typeId: 'associate-role',
+          id: expect.any(String),
+        }),
+        inheritance: expect.any(String),
+      })
+    )
+  );
+});

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/builder.ts

@@ -0,0 +1,15 @@
+import { Builder } from '@commercetools-test-data/core';
+import generator from './generator';
+import transformers from './transformers';
+import type {
+  TCreateAssociateRoleAssignmentDraftBuilder,
+  TAssociateRoleAssignmentDraft,
+} from '../types';
+
+const Model: TCreateAssociateRoleAssignmentDraftBuilder = () =>
+  Builder<TAssociateRoleAssignmentDraft>({
+    generator,
+    transformers,
+  });
+
+export default Model;

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/generator.ts

@@ -0,0 +1,17 @@
+import { ReferenceDraft } from '@commercetools-test-data/commons';
+import { fake, Generator, oneOf } from '@commercetools-test-data/core';
+import { associateRoleInheritanceMode } from '../constants';
+import { TAssociateRoleAssignmentDraft } from '../types';
+
+// https://docs.commercetools.com/api/projects/business-units#associateroleassignmentdraft
+
+const generator = Generator<TAssociateRoleAssignmentDraft>({
+  fields: {
+    associateRole: fake(() =>
+      ReferenceDraft.presets.associateRoleReference.associateRoleReference()
+    ),
+    inheritance: oneOf(...Object.values(associateRoleInheritanceMode)),
+  },
+});
+
+export default generator;

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/index.ts

@@ -0,0 +1,2 @@
+export { default as random } from './builder';
+export { default as presets } from './presets';

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/presets/index.ts

@@ -0,0 +1,3 @@
+const presets = {};
+
+export default presets;

models/business-unit/src/associate-role-assignment/associate-role-assignment-draft/transformers.ts

@@ -0,0 +1,22 @@
+import { Transformer } from '@commercetools-test-data/core';
+import type {
+  TAssociateRoleAssignmentDraft,
+  TAssociateRoleAssignmentDraftGraphql,
+} from '../types';
+
+const transformers = {
+  default: Transformer<
+    TAssociateRoleAssignmentDraft,
+    TAssociateRoleAssignmentDraft
+  >('default', { buildFields: ['associateRole'] }),
+  rest: Transformer<
+    TAssociateRoleAssignmentDraft,
+    TAssociateRoleAssignmentDraft
+  >('rest', { buildFields: ['associateRole'] }),
+  graphql: Transformer<
+    TAssociateRoleAssignmentDraft,
+    TAssociateRoleAssignmentDraftGraphql
+  >('graphql', { buildFields: ['associateRole'] }),
+};
+
+export default transformers;

models/business-unit/src/associate-role-assignment/builder.spec.ts

@@ -0,0 +1,65 @@
+/* eslint-disable jest/no-disabled-tests */
+/* eslint-disable jest/valid-title */
+import { createBuilderSpec } from '@commercetools-test-data/core/test-utils';
+import {
+  TAssociateRoleAssignmentDefault,
+  TAssociateRoleAssignmentRest,
+  TAssociateRoleAssignmentGraphql,
+} from './types';
+import * as AssociateRoleAssignment from '.';
+
+describe('builder', () => {
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDefault,
+      TAssociateRoleAssignmentDefault
+    >(
+      'default',
+      AssociateRoleAssignment.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          id: expect.any(String),
+        }),
+        inheritance: expect.any(String),
+      })
+    )
+  );
+
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDefault,
+      TAssociateRoleAssignmentRest
+    >(
+      'rest',
+      AssociateRoleAssignment.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          typeId: 'associate-role',
+        }),
+        inheritance: expect.any(String),
+      })
+    )
+  );
+
+  it(
+    ...createBuilderSpec<
+      TAssociateRoleAssignmentDefault,
+      TAssociateRoleAssignmentGraphql
+    >(
+      'graphql',
+      AssociateRoleAssignment.random(),
+      expect.objectContaining({
+        associateRole: expect.objectContaining({
+          id: expect.any(String),
+        }),
+        associateRoleRef: expect.objectContaining({
+          typeId: 'associate-role',
+          key: expect.any(String),
+          __typename: 'Reference',
+        }),
+        inheritance: expect.any(String),
+        __typename: 'AssociateRoleAssignment',
+      })
+    )
+  );
+});

models/business-unit/src/associate-role-assignment/builder.ts

@@ -0,0 +1,15 @@
+import { Builder } from '@commercetools-test-data/core';
+import generator from './generator';
+import transformers from './transformers';
+import type {
+  TAssociateRoleAssignmentDefault,
+  TCreateAssociateRoleAssignmentBuilder,
+} from './types';
+
+const Model: TCreateAssociateRoleAssignmentBuilder = () =>
+  Builder<TAssociateRoleAssignmentDefault>({
+    generator,
+    transformers,
+  });
+
+export default Model;

models/business-unit/src/associate-role-assignment/constants.ts

@@ -0,0 +1,4 @@
+export const associateRoleInheritanceMode = {
+  Enabled: 'Enabled',
+  Disabled: 'Disabled',
+} as const;

models/business-unit/src/associate-role-assignment/generator.ts

@@ -0,0 +1,15 @@
+import { AssociateRole } from '@commercetools-test-data/associate-role';
+import { fake, Generator, oneOf } from '@commercetools-test-data/core';
+import { associateRoleInheritanceMode } from './constants';
+import { TAssociateRoleAssignmentDefault } from './types';
+
+// https://docs.commercetools.com/api/projects/business-units#associateroleassignment
+
+const generator = Generator<TAssociateRoleAssignmentDefault>({
+  fields: {
+    associateRole: fake(() => AssociateRole.random()),
+    inheritance: oneOf(...Object.values(associateRoleInheritanceMode)),
+  },
+});
+
+export default generator;

models/business-unit/src/associate-role-assignment/index.ts

@@ -0,0 +1,5 @@
+export * from './types';
+export * as AssociateRoleAssignmentDraft from './associate-role-assignment-draft';
+
+export { default as random } from './builder';
+export { default as presets } from './presets';

models/business-unit/src/associate-role-assignment/presets/index.ts

@@ -0,0 +1,3 @@
+const presets = {};
+
+export default presets;

models/business-unit/src/associate-role-assignment/transformers.ts

@@ -0,0 +1,53 @@
+import { type AssociateRoleKeyReference } from '@commercetools/platform-sdk';
+import { KeyReference } from '@commercetools-test-data/commons';
+import { Transformer } from '@commercetools-test-data/core';
+import type {
+  TAssociateRoleAssignmentDefault,
+  TAssociateRoleAssignmentRest,
+  TAssociateRoleAssignmentGraphql,
+} from './types';
+
+const transformers = {
+  default: Transformer<
+    TAssociateRoleAssignmentDefault,
+    TAssociateRoleAssignmentDefault
+  >('default', {
+    buildFields: ['associateRole'],
+  }),
+  rest: Transformer<
+    TAssociateRoleAssignmentDefault,
+    TAssociateRoleAssignmentRest
+  >('rest', {
+    buildFields: ['associateRole'],
+    replaceFields: ({ fields }) => {
+      const associateRole: AssociateRoleKeyReference = KeyReference.presets
+        .associateRole()
+        .key(fields.associateRole.key)
+        .build();
+      return {
+        ...fields,
+        associateRole,
+      };
+    },
+  }),
+  graphql: Transformer<
+    TAssociateRoleAssignmentDefault,
+    TAssociateRoleAssignmentGraphql
+  >('graphql', {
+    buildFields: ['associateRole'],
+    addFields: ({ fields }) => {
+      const associateRoleRef: AssociateRoleKeyReference = KeyReference.presets
+        .associateRole()
+        .key(fields.associateRole.key)
+        .buildGraphql();
+
+      return {
+        ...fields,
+        associateRoleRef,
+        __typename: 'AssociateRoleAssignment',
+      };
+    },
+  }),
+};
+
+export default transformers;

models/business-unit/src/associate-role-assignment/types.ts

@@ -0,0 +1,33 @@
+import type {
+  AssociateRoleKeyReference,
+  AssociateRole,
+  AssociateRoleAssignment,
+  AssociateRoleAssignmentDraft,
+} from '@commercetools/platform-sdk';
+import type { TBuilder } from '@commercetools-test-data/core';
+
+export type TAssociateRoleAssignmentDraft = AssociateRoleAssignmentDraft;
+export type TAssociateRoleAssignmentDraftGraphql =
+  TAssociateRoleAssignmentDraft;
+
+export type TAssociateRoleAssignmentDefault = Omit<
+  AssociateRoleAssignment,
+  'associateRole'
+> & {
+  associateRole: AssociateRole;
+};
+export type TAssociateRoleAssignmentRest = AssociateRoleAssignment;
+export type TAssociateRoleAssignmentGraphql =
+  TAssociateRoleAssignmentDefault & {
+    associateRoleRef: AssociateRoleKeyReference | null;
+    __typename: 'AssociateRoleAssignment';
+  };
+
+export type TAssociateRoleAssignmentDraftBuilder =
+  TBuilder<TAssociateRoleAssignmentDraft>;
+export type TCreateAssociateRoleAssignmentDraftBuilder =
+  () => TAssociateRoleAssignmentDraftBuilder;
+export type TAssociateRoleAssignmentBuilder =
+  TBuilder<TAssociateRoleAssignmentDefault>;
+export type TCreateAssociateRoleAssignmentBuilder =
+  () => TAssociateRoleAssignmentBuilder;