refactor: use generate types for custom view (#591)

* refactor: use generate types for custom view and include custom application installation in custom view * refactor: update test for type-settings * Update .changeset/lovely-waves-notice.md Co-authored-by: Kacper Krzywiec <[email protected]> --------- Co-authored-by: Kacper Krzywiec <[email protected]>
commercetools · May 27, 2024 · ac42d1b · ac42d1b
1 parent a5c62fb
commit ac42d1b
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 58 deletions.
diff --git a/.changeset/lovely-waves-notice.md b/.changeset/lovely-waves-notice.md
@@ -0,0 +1,6 @@
+---
+'@commercetools-test-data/custom-view': patch
+---
+
+- Use generated types for custom view
+- Include custom view installation in custom view
diff --git a/models/custom-view/src/custom-view-type-settings-for-custom-panel/builder.spec.ts b/models/custom-view/src/custom-view-type-settings-for-custom-panel/builder.spec.ts
@@ -1,6 +1,7 @@
 /* eslint-disable jest/no-disabled-tests */
 /* eslint-disable jest/valid-title */
 import { createBuilderSpec } from '@commercetools-test-data/core/test-utils';
+import { TMcSettingsCustomViewSize } from '@commercetools-test-data/graphql-types';
 import type {
   TCustomViewTypeSettingsForCustomPanel,
   TCustomViewTypeSettingsForCustomPanelGraphql,
@@ -27,7 +28,7 @@ describe('builder', () => {
       TCustomViewTypeSettingsForCustomPanelGraphql
     >(
       'graphql',
-      CustomViewTypeSettings.random().size('SMALL'),
+      CustomViewTypeSettings.random().size(TMcSettingsCustomViewSize.Small),
       expect.objectContaining({
         __typename: 'CustomViewTypeSettings',
         size: 'SMALL',

diff --git a/models/custom-view/src/custom-view-type-settings-for-custom-panel/types.ts b/models/custom-view/src/custom-view-type-settings-for-custom-panel/types.ts
@@ -1,14 +1,13 @@
 import { TBuilder } from '@commercetools-test-data/core';
+import type { TMcSettingsCustomViewTypeSettings } from '@commercetools-test-data/graphql-types';
 
-export type CustomViewSize = 'SMALL' | 'LARGE';
-
-export type TCustomViewTypeSettingsForCustomPanel = {
-  size: CustomViewSize;
-};
 export type TCustomViewTypeSettingsForCustomPanelGraphql =
-  TCustomViewTypeSettingsForCustomPanel & {
-    __typename: 'CustomViewTypeSettings';
-  };
+  TMcSettingsCustomViewTypeSettings;
+
+export type TCustomViewTypeSettingsForCustomPanel = Omit<
+  TCustomViewTypeSettingsForCustomPanelGraphql,
+  '__typename'
+>;
 
 export type TCustomViewTypeSettingsForCustomPanelBuilder =
   TBuilder<TCustomViewTypeSettingsForCustomPanel>;

diff --git a/models/custom-view/src/custom-view/builder.spec.ts b/models/custom-view/src/custom-view/builder.spec.ts
@@ -34,6 +34,23 @@ describe('builder', () => {
           size: expect.stringMatching(/^(SMALL|LARGE)$/),
         }),
         url: expect.any(String),
+        installedBy: expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(String),
+            createdAt: expect.any(String),
+            updatedAt: expect.any(String),
+            acceptedPermissions: expect.arrayContaining([
+              expect.objectContaining({
+                name: expect.stringMatching(/^(view|manage)$/),
+                oAuthScopes: expect.arrayContaining([expect.any(String)]),
+              }),
+            ]),
+            installInAllProjects: expect.any(Boolean),
+            projects: expect.any(Array),
+            ownerId: expect.any(String),
+            owner: expect.any(Object),
+          }),
+        ]),
       })
     )
   );
@@ -67,6 +84,24 @@ describe('builder', () => {
           size: expect.stringMatching(/^(SMALL|LARGE)$/),
         }),
         url: expect.any(String),
+        installedBy: expect.arrayContaining([
+          expect.objectContaining({
+            __typename: 'CustomViewInstallation',
+            id: expect.any(String),
+            createdAt: expect.any(String),
+            updatedAt: expect.any(String),
+            acceptedPermissions: expect.arrayContaining([
+              expect.objectContaining({
+                name: expect.stringMatching(/^(view|manage)$/),
+                oAuthScopes: expect.arrayContaining([expect.any(String)]),
+              }),
+            ]),
+            installInAllProjects: expect.any(Boolean),
+            projects: expect.any(Array),
+            ownerId: expect.any(String),
+            owner: expect.any(Object),
+          }),
+        ]),
       })
     )
   );

diff --git a/models/custom-view/src/custom-view/generator.ts b/models/custom-view/src/custom-view/generator.ts
@@ -1,10 +1,11 @@
 import { LocalizedField } from '@commercetools-test-data/commons';
 import { fake, Generator } from '@commercetools-test-data/core';
 import { createRelatedDates } from '@commercetools-test-data/utils';
+import { CustomViewInstallation } from '../custom-view-installation';
 import * as CustomViewPermission from '../custom-view-permission';
 import * as CustomViewTypeSettingsForCustomPanel from '../custom-view-type-settings-for-custom-panel';
 import { defaultLocators } from './constants';
-import { TCustomView } from './types';
+import type { TCustomView } from './types';
 
 const [getOlderDate, getNewerDate] = createRelatedDates();
 
@@ -28,7 +29,8 @@ const generator = Generator<TCustomView>({
     ]),
     status: fake((f) => f.helpers.arrayElement(['DRAFT', 'PRIVATE_USAGE'])),
     type: fake((f) => f.helpers.arrayElement(['CustomPanel'])),
-    typeSettings: fake((f) => CustomViewTypeSettingsForCustomPanel.random()),
+    typeSettings: fake(() => CustomViewTypeSettingsForCustomPanel.random()),
+    installedBy: fake(() => [CustomViewInstallation.random()]),
     createdAt: fake(getOlderDate),
     updatedAt: fake(getNewerDate),
   },

diff --git a/models/custom-view/src/custom-view/transformers.ts b/models/custom-view/src/custom-view/transformers.ts
@@ -3,10 +3,20 @@ import type { TCustomView, TCustomViewGraphql } from './types';
 
 const transformers = {
   default: Transformer<TCustomView, TCustomView>('default', {
-    buildFields: ['labelAllLocales', 'permissions', 'typeSettings'],
+    buildFields: [
+      'labelAllLocales',
+      'permissions',
+      'typeSettings',
+      'installedBy',
+    ],
   }),
   graphql: Transformer<TCustomView, TCustomViewGraphql>('graphql', {
-    buildFields: ['labelAllLocales', 'permissions', 'typeSettings'],
+    buildFields: [
+      'labelAllLocales',
+      'permissions',
+      'typeSettings',
+      'installedBy',
+    ],
     addFields: () => ({
       __typename: 'CustomView',
     }),

diff --git a/models/custom-view/src/custom-view/types.ts b/models/custom-view/src/custom-view/types.ts
@@ -1,53 +1,16 @@
 import { TBuilder } from '@commercetools-test-data/core';
+import type {
+  TMcSettingsCustomView,
+  TMcSettingsCustomViewDraftDataInput,
+} from '@commercetools-test-data/graphql-types';
 
-// TODO: generate graphql types and use those
+export type TCustomViewGraphql = TMcSettingsCustomView;
 
-type LocalizedField = {
-  id?: string;
-  locale: string;
-  value?: string;
-};
+export type TCustomView = Omit<TCustomViewGraphql, '__typename' | 'owner'>;
 
-type CustomViewType = 'CustomPanel';
+export type TCustomViewDraftGraphql = TMcSettingsCustomViewDraftDataInput;
 
-type CustomViewSize = 'SMALL' | 'LARGE';
-
-type CustomViewStatus = 'DRAFT' | 'PRIVATE_USAGE';
-
-type CustomViewTypeSettings = {
-  size?: CustomViewSize;
-};
-
-type CustomViewPermission = {
-  name: string;
-  oAuthScopes: string[];
-};
-
-export type TCustomView = {
-  id: string;
-  // owner: OrganizationExtension;
-  ownerId: string;
-  url: string;
-  defaultLabel: string;
-  description?: string;
-  labelAllLocales: LocalizedField[];
-  locators: string[];
-  permissions: CustomViewPermission[];
-  status: CustomViewStatus;
-  type: CustomViewType;
-  typeSettings?: CustomViewTypeSettings;
-  createdAt: string;
-  updatedAt: string;
-};
-export type TCustomViewGraphql = TCustomView & {
-  __typename: 'CustomView';
-};
-
-export type TCustomViewDraft = Omit<
-  TCustomView,
-  'id' | 'createdAt' | 'updatedAt' | 'ownerId' | 'status'
->;
-export type TCustomViewDraftGraphql = TCustomViewDraft;
+export type TCustomViewDraft = Omit<TCustomViewDraftGraphql, '__typename'>;
 
 export type TCustomViewBuilder = TBuilder<TCustomView>;
 export type TCreateCustomViewBuilder = () => TCustomViewBuilder;