feat(core): Make Promotion entity translatable, add description

Relates to #1990 BREAKING CHANGE: The Promotion entity is now translatable, which means existing promotions will need to be migrated to the new DB schema and care taken to preserve the name data. Also the GraphQL API for creating and updating Promotions, as well as the corresponding PromotionService methods have changed to take a `translations` array for setting the `name` and `description` in a given language.
vendure-ecommerce · Feb 24, 2023 · dada243 · dada243
1 parent 06efc50
commit dada243
Show file tree

Hide file tree

Showing 25 changed files with 340 additions and 74 deletions.
diff --git a/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts b/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts
@@ -790,9 +790,9 @@ export type CreatePromotionInput = {
     customFields?: InputMaybe<Scalars['JSON']>;
     enabled: Scalars['Boolean'];
     endsAt?: InputMaybe<Scalars['DateTime']>;
-    name: Scalars['String'];
     perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
     startsAt?: InputMaybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslationInput>;
 };
 
 export type CreatePromotionResult = MissingConditionsError | Promotion;
@@ -4202,18 +4202,21 @@ export type Promotion = Node & {
     couponCode?: Maybe<Scalars['String']>;
     createdAt: Scalars['DateTime'];
     customFields?: Maybe<Scalars['JSON']>;
+    description: Scalars['String'];
     enabled: Scalars['Boolean'];
     endsAt?: Maybe<Scalars['DateTime']>;
     id: Scalars['ID'];
     name: Scalars['String'];
     perCustomerUsageLimit?: Maybe<Scalars['Int']>;
     startsAt?: Maybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslation>;
     updatedAt: Scalars['DateTime'];
 };
 
 export type PromotionFilterParameter = {
     couponCode?: InputMaybe<StringOperators>;
     createdAt?: InputMaybe<DateOperators>;
+    description?: InputMaybe<StringOperators>;
     enabled?: InputMaybe<BooleanOperators>;
     endsAt?: InputMaybe<DateOperators>;
     id?: InputMaybe<IdOperators>;
@@ -4244,6 +4247,7 @@ export type PromotionListOptions = {
 export type PromotionSortParameter = {
     couponCode?: InputMaybe<SortOrder>;
     createdAt?: InputMaybe<SortOrder>;
+    description?: InputMaybe<SortOrder>;
     endsAt?: InputMaybe<SortOrder>;
     id?: InputMaybe<SortOrder>;
     name?: InputMaybe<SortOrder>;
@@ -4252,6 +4256,23 @@ export type PromotionSortParameter = {
     updatedAt?: InputMaybe<SortOrder>;
 };
 
+export type PromotionTranslation = {
+    createdAt: Scalars['DateTime'];
+    description: Scalars['String'];
+    id: Scalars['ID'];
+    languageCode: LanguageCode;
+    name: Scalars['String'];
+    updatedAt: Scalars['DateTime'];
+};
+
+export type PromotionTranslationInput = {
+    customFields?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    id?: InputMaybe<Scalars['ID']>;
+    languageCode: LanguageCode;
+    name?: InputMaybe<Scalars['String']>;
+};
+
 /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
 export type QuantityTooGreatError = ErrorResult & {
     errorCode: ErrorCode;
@@ -5510,9 +5531,9 @@ export type UpdatePromotionInput = {
     enabled?: InputMaybe<Scalars['Boolean']>;
     endsAt?: InputMaybe<Scalars['DateTime']>;
     id: Scalars['ID'];
-    name?: InputMaybe<Scalars['String']>;
     perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
     startsAt?: InputMaybe<Scalars['DateTime']>;
+    translations?: InputMaybe<Array<PromotionTranslationInput>>;
 };
 
 export type UpdatePromotionResult = MissingConditionsError | Promotion;

diff --git a/packages/common/src/generated-shop-types.ts b/packages/common/src/generated-shop-types.ts
@@ -2696,12 +2696,14 @@ export type Promotion = Node & {
     couponCode?: Maybe<Scalars['String']>;
     createdAt: Scalars['DateTime'];
     customFields?: Maybe<Scalars['JSON']>;
+    description: Scalars['String'];
     enabled: Scalars['Boolean'];
     endsAt?: Maybe<Scalars['DateTime']>;
     id: Scalars['ID'];
     name: Scalars['String'];
     perCustomerUsageLimit?: Maybe<Scalars['Int']>;
     startsAt?: Maybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslation>;
     updatedAt: Scalars['DateTime'];
 };
 
@@ -2711,6 +2713,16 @@ export type PromotionList = PaginatedList & {
     totalItems: Scalars['Int'];
 };
 
+export type PromotionTranslation = {
+    __typename?: 'PromotionTranslation';
+    createdAt: Scalars['DateTime'];
+    description: Scalars['String'];
+    id: Scalars['ID'];
+    languageCode: LanguageCode;
+    name: Scalars['String'];
+    updatedAt: Scalars['DateTime'];
+};
+
 export type Query = {
     __typename?: 'Query';
     /** The active Channel */

diff --git a/packages/common/src/generated-types.ts b/packages/common/src/generated-types.ts
@@ -804,9 +804,9 @@ export type CreatePromotionInput = {
   customFields?: InputMaybe<Scalars['JSON']>;
   enabled: Scalars['Boolean'];
   endsAt?: InputMaybe<Scalars['DateTime']>;
-  name: Scalars['String'];
   perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
   startsAt?: InputMaybe<Scalars['DateTime']>;
+  translations: Array<PromotionTranslationInput>;
 };
 
 export type CreatePromotionResult = MissingConditionsError | Promotion;
@@ -4423,18 +4423,21 @@ export type Promotion = Node & {
   couponCode?: Maybe<Scalars['String']>;
   createdAt: Scalars['DateTime'];
   customFields?: Maybe<Scalars['JSON']>;
+  description: Scalars['String'];
   enabled: Scalars['Boolean'];
   endsAt?: Maybe<Scalars['DateTime']>;
   id: Scalars['ID'];
   name: Scalars['String'];
   perCustomerUsageLimit?: Maybe<Scalars['Int']>;
   startsAt?: Maybe<Scalars['DateTime']>;
+  translations: Array<PromotionTranslation>;
   updatedAt: Scalars['DateTime'];
 };
 
 export type PromotionFilterParameter = {
   couponCode?: InputMaybe<StringOperators>;
   createdAt?: InputMaybe<DateOperators>;
+  description?: InputMaybe<StringOperators>;
   enabled?: InputMaybe<BooleanOperators>;
   endsAt?: InputMaybe<DateOperators>;
   id?: InputMaybe<IdOperators>;
@@ -4466,6 +4469,7 @@ export type PromotionListOptions = {
 export type PromotionSortParameter = {
   couponCode?: InputMaybe<SortOrder>;
   createdAt?: InputMaybe<SortOrder>;
+  description?: InputMaybe<SortOrder>;
   endsAt?: InputMaybe<SortOrder>;
   id?: InputMaybe<SortOrder>;
   name?: InputMaybe<SortOrder>;
@@ -4474,6 +4478,24 @@ export type PromotionSortParameter = {
   updatedAt?: InputMaybe<SortOrder>;
 };
 
+export type PromotionTranslation = {
+  __typename?: 'PromotionTranslation';
+  createdAt: Scalars['DateTime'];
+  description: Scalars['String'];
+  id: Scalars['ID'];
+  languageCode: LanguageCode;
+  name: Scalars['String'];
+  updatedAt: Scalars['DateTime'];
+};
+
+export type PromotionTranslationInput = {
+  customFields?: InputMaybe<Scalars['JSON']>;
+  description?: InputMaybe<Scalars['String']>;
+  id?: InputMaybe<Scalars['ID']>;
+  languageCode: LanguageCode;
+  name?: InputMaybe<Scalars['String']>;
+};
+
 /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
 export type QuantityTooGreatError = ErrorResult & {
   __typename?: 'QuantityTooGreatError';
@@ -5802,9 +5824,9 @@ export type UpdatePromotionInput = {
   enabled?: InputMaybe<Scalars['Boolean']>;
   endsAt?: InputMaybe<Scalars['DateTime']>;
   id: Scalars['ID'];
-  name?: InputMaybe<Scalars['String']>;
   perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
   startsAt?: InputMaybe<Scalars['DateTime']>;
+  translations?: InputMaybe<Array<PromotionTranslationInput>>;
 };
 
 export type UpdatePromotionResult = MissingConditionsError | Promotion;

diff --git a/packages/core/e2e/active-order-strategy.e2e-spec.ts b/packages/core/e2e/active-order-strategy.e2e-spec.ts
@@ -1,3 +1,4 @@
+import { LanguageCode } from '@vendure/common/lib/generated-types';
 import { mergeConfig, orderPercentageDiscount } from '@vendure/core';
 import { createTestEnvironment } from '@vendure/testing';
 import gql from 'graphql-tag';
@@ -148,7 +149,6 @@ describe('custom ActiveOrderStrategy', () => {
                 {
                     input: {
                         enabled: true,
-                        name: 'Free with test coupon',
                         couponCode: TEST_COUPON_CODE,
                         conditions: [],
                         actions: [
@@ -157,6 +157,7 @@ describe('custom ActiveOrderStrategy', () => {
                                 arguments: [{ name: 'discount', value: '100' }],
                             },
                         ],
+                        translations: [{ languageCode: LanguageCode.en, name: 'Free with test coupon' }],
                     },
                 },
             );

diff --git a/packages/core/e2e/draft-order.e2e-spec.ts b/packages/core/e2e/draft-order.e2e-spec.ts
@@ -1,4 +1,5 @@
 /* tslint:disable:no-non-null-assertion */
+import { LanguageCode } from '@vendure/common/lib/generated-types';
 import { DefaultLogger, mergeConfig, orderPercentageDiscount } from '@vendure/core';
 import { createErrorResultGuard, createTestEnvironment, ErrorResultGuard } from '@vendure/testing';
 import gql from 'graphql-tag';
@@ -72,7 +73,6 @@ describe('Draft Orders resolver', () => {
             Codegen.CreatePromotionMutationVariables
         >(CREATE_PROMOTION, {
             input: {
-                name: 'Free Order',
                 enabled: true,
                 conditions: [],
                 couponCode: freeOrderCouponCode,
@@ -82,6 +82,7 @@ describe('Draft Orders resolver', () => {
                         arguments: [{ name: 'discount', value: '100' }],
                     },
                 ],
+                translations: [{ languageCode: LanguageCode.en, name: 'Free Order' }],
             },
         });
     }, TEST_SETUP_TIMEOUT_MS);

diff --git a/packages/core/e2e/graphql/generated-e2e-admin-types.ts b/packages/core/e2e/graphql/generated-e2e-admin-types.ts
@@ -790,9 +790,9 @@ export type CreatePromotionInput = {
     customFields?: InputMaybe<Scalars['JSON']>;
     enabled: Scalars['Boolean'];
     endsAt?: InputMaybe<Scalars['DateTime']>;
-    name: Scalars['String'];
     perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
     startsAt?: InputMaybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslationInput>;
 };
 
 export type CreatePromotionResult = MissingConditionsError | Promotion;
@@ -4202,18 +4202,21 @@ export type Promotion = Node & {
     couponCode?: Maybe<Scalars['String']>;
     createdAt: Scalars['DateTime'];
     customFields?: Maybe<Scalars['JSON']>;
+    description: Scalars['String'];
     enabled: Scalars['Boolean'];
     endsAt?: Maybe<Scalars['DateTime']>;
     id: Scalars['ID'];
     name: Scalars['String'];
     perCustomerUsageLimit?: Maybe<Scalars['Int']>;
     startsAt?: Maybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslation>;
     updatedAt: Scalars['DateTime'];
 };
 
 export type PromotionFilterParameter = {
     couponCode?: InputMaybe<StringOperators>;
     createdAt?: InputMaybe<DateOperators>;
+    description?: InputMaybe<StringOperators>;
     enabled?: InputMaybe<BooleanOperators>;
     endsAt?: InputMaybe<DateOperators>;
     id?: InputMaybe<IdOperators>;
@@ -4244,6 +4247,7 @@ export type PromotionListOptions = {
 export type PromotionSortParameter = {
     couponCode?: InputMaybe<SortOrder>;
     createdAt?: InputMaybe<SortOrder>;
+    description?: InputMaybe<SortOrder>;
     endsAt?: InputMaybe<SortOrder>;
     id?: InputMaybe<SortOrder>;
     name?: InputMaybe<SortOrder>;
@@ -4252,6 +4256,23 @@ export type PromotionSortParameter = {
     updatedAt?: InputMaybe<SortOrder>;
 };
 
+export type PromotionTranslation = {
+    createdAt: Scalars['DateTime'];
+    description: Scalars['String'];
+    id: Scalars['ID'];
+    languageCode: LanguageCode;
+    name: Scalars['String'];
+    updatedAt: Scalars['DateTime'];
+};
+
+export type PromotionTranslationInput = {
+    customFields?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    id?: InputMaybe<Scalars['ID']>;
+    languageCode: LanguageCode;
+    name?: InputMaybe<Scalars['String']>;
+};
+
 /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
 export type QuantityTooGreatError = ErrorResult & {
     errorCode: ErrorCode;
@@ -5510,9 +5531,9 @@ export type UpdatePromotionInput = {
     enabled?: InputMaybe<Scalars['Boolean']>;
     endsAt?: InputMaybe<Scalars['DateTime']>;
     id: Scalars['ID'];
-    name?: InputMaybe<Scalars['String']>;
     perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
     startsAt?: InputMaybe<Scalars['DateTime']>;
+    translations?: InputMaybe<Array<PromotionTranslationInput>>;
 };
 
 export type UpdatePromotionResult = MissingConditionsError | Promotion;

diff --git a/packages/core/e2e/graphql/generated-e2e-shop-types.ts b/packages/core/e2e/graphql/generated-e2e-shop-types.ts
@@ -2604,12 +2604,14 @@ export type Promotion = Node & {
     couponCode?: Maybe<Scalars['String']>;
     createdAt: Scalars['DateTime'];
     customFields?: Maybe<Scalars['JSON']>;
+    description: Scalars['String'];
     enabled: Scalars['Boolean'];
     endsAt?: Maybe<Scalars['DateTime']>;
     id: Scalars['ID'];
     name: Scalars['String'];
     perCustomerUsageLimit?: Maybe<Scalars['Int']>;
     startsAt?: Maybe<Scalars['DateTime']>;
+    translations: Array<PromotionTranslation>;
     updatedAt: Scalars['DateTime'];
 };
 
@@ -2618,6 +2620,15 @@ export type PromotionList = PaginatedList & {
     totalItems: Scalars['Int'];
 };
 
+export type PromotionTranslation = {
+    createdAt: Scalars['DateTime'];
+    description: Scalars['String'];
+    id: Scalars['ID'];
+    languageCode: LanguageCode;
+    name: Scalars['String'];
+    updatedAt: Scalars['DateTime'];
+};
+
 export type Query = {
     /** The active Channel */
     activeChannel: Channel;