feat(core): I18n for descriptions and labels of ConfigurableOperations

BREAKING CHANGE: ConfigurableOperations descriptions must now be specified as an array of LocalizedString rather than just a plain string. This allows the descriptions to be adapted to other locales.
vendure-ecommerce · Aug 6, 2019 · a135e15 · a135e15
1 parent d17aaa9
commit a135e15
Show file tree

Hide file tree

Showing 37 changed files with 264 additions and 176 deletions.
diff --git a/packages/common/src/generated-shop-types.ts b/packages/common/src/generated-shop-types.ts
@@ -217,6 +217,8 @@ export type ConfigArgDefinition = {
     __typename?: 'ConfigArgDefinition';
     name: Scalars['String'];
     type: Scalars['String'];
+    label?: Maybe<Scalars['String']>;
+    description?: Maybe<Scalars['String']>;
     config?: Maybe<Scalars['JSON']>;
 };
 
@@ -230,7 +232,6 @@ export type ConfigurableOperation = {
     __typename?: 'ConfigurableOperation';
     code: Scalars['String'];
     args: Array<ConfigArg>;
-    description: Scalars['String'];
 };
 
 export type ConfigurableOperationDefinition = {
@@ -1816,12 +1817,6 @@ export type PromotionList = PaginatedList & {
     totalItems: Scalars['Int'];
 };
 
-export type PromotionOperations = {
-    __typename?: 'PromotionOperations';
-    conditions: Array<ConfigurableOperationDefinition>;
-    actions: Array<ConfigurableOperationDefinition>;
-};
-
 export type Query = {
     __typename?: 'Query';
     activeChannel: Channel;

diff --git a/packages/common/src/generated-types.ts b/packages/common/src/generated-types.ts
@@ -293,6 +293,8 @@ export type ConfigArgDefinition = {
   __typename?: 'ConfigArgDefinition',
   name: Scalars['String'],
   type: Scalars['String'],
+  label?: Maybe<Scalars['String']>,
+  description?: Maybe<Scalars['String']>,
   config?: Maybe<Scalars['JSON']>,
 };
 
@@ -306,7 +308,6 @@ export type ConfigurableOperation = {
   __typename?: 'ConfigurableOperation',
   code: Scalars['String'],
   args: Array<ConfigArg>,
-  description: Scalars['String'],
 };
 
 export type ConfigurableOperationDefinition = {
@@ -2584,12 +2585,6 @@ export type PromotionListOptions = {
   filter?: Maybe<PromotionFilterParameter>,
 };
 
-export type PromotionOperations = {
-  __typename?: 'PromotionOperations',
-  conditions: Array<ConfigurableOperationDefinition>,
-  actions: Array<ConfigurableOperationDefinition>,
-};
-
 export type PromotionSortParameter = {
   id?: Maybe<SortOrder>,
   createdAt?: Maybe<SortOrder>,

diff --git a/packages/common/src/shared-types.ts b/packages/common/src/shared-types.ts
@@ -55,14 +55,8 @@ export type CustomFieldType = 'string' | 'localeString' | 'int' | 'float' | 'boo
  * 1. How the argument form field is rendered in the admin-ui
  * 2. The JavaScript type into which the value is coerced before being passed to the business logic.
  */
-export type ConfigArgType =
-    | 'string'
-    | 'int'
-    | 'float'
-    | 'boolean'
-    | 'datetime'
-    | 'facetValueIds'
-    | 'stringOperator';
+export type ConfigArgType = 'string' | 'int' | 'float' | 'boolean' | 'datetime' | 'facetValueIds';
+
 export type ConfigArgSubset<T extends ConfigArgType> = T;
 
 export type CustomFieldsObject = { [key: string]: any };

diff --git a/packages/core/e2e/__snapshots__/collection.e2e-spec.ts.snap b/packages/core/e2e/__snapshots__/collection.e2e-spec.ts.snap
@@ -48,7 +48,6 @@ Object {
         },
       ],
       "code": "facet-value-filter",
-      "description": "Filter by FacetValues",
     },
   ],
   "id": "T_3",
@@ -109,7 +108,6 @@ Object {
         },
       ],
       "code": "facet-value-filter",
-      "description": "Filter by FacetValues",
     },
   ],
   "id": "T_5",

diff --git a/packages/core/e2e/__snapshots__/promotion.e2e-spec.ts.snap b/packages/core/e2e/__snapshots__/promotion.e2e-spec.ts.snap
@@ -55,7 +55,6 @@ Object {
         },
       ],
       "code": "promo_action",
-      "description": "description for promo_action",
     },
   ],
   "conditions": Array [
@@ -68,7 +67,6 @@ Object {
         },
       ],
       "code": "promo_condition",
-      "description": "description for promo_condition",
     },
   ],
   "enabled": true,
@@ -88,7 +86,6 @@ Object {
         },
       ],
       "code": "promo_action",
-      "description": "description for promo_action",
     },
   ],
   "conditions": Array [
@@ -101,7 +98,6 @@ Object {
         },
       ],
       "code": "promo_condition",
-      "description": "description for promo_condition",
     },
     Object {
       "args": Array [
@@ -112,7 +108,6 @@ Object {
         },
       ],
       "code": "promo_condition2",
-      "description": "description for promo_condition2",
     },
   ],
   "enabled": true,

diff --git a/packages/core/e2e/collection.e2e-spec.ts b/packages/core/e2e/collection.e2e-spec.ts
@@ -4,7 +4,6 @@ import gql from 'graphql-tag';
 import path from 'path';
 
 import { pick } from '../../common/lib/pick';
-import { StringOperator } from '../src/common/configurable-operation';
 import {
     facetValueCollectionFilter,
     variantNameCollectionFilter,
@@ -414,7 +413,7 @@ describe('Collection resolver', () => {
                                 {
                                     name: 'operator',
                                     value: 'contains',
-                                    type: 'stringOperator',
+                                    type: 'string',
                                 },
                                 {
                                     name: 'term',
@@ -662,7 +661,7 @@ describe('Collection resolver', () => {
 
         describe('variantName filter', () => {
             async function createVariantNameFilteredCollection(
-                operator: StringOperator,
+                operator: string,
                 term: string,
             ): Promise<Collection.Fragment> {
                 const { createCollection } = await client.query<
@@ -680,7 +679,7 @@ describe('Collection resolver', () => {
                                     {
                                         name: 'operator',
                                         value: operator,
-                                        type: 'stringOperator',
+                                        type: 'string',
                                     },
                                     {
                                         name: 'term',

diff --git a/packages/core/e2e/graphql/fragments.ts b/packages/core/e2e/graphql/fragments.ts
@@ -149,7 +149,6 @@ export const CONFIGURABLE_FRAGMENT = gql`
             value
         }
         code
-        description
     }
 `;
 
@@ -239,7 +238,6 @@ export const COUNTRY_FRAGMENT = gql`
     }
 `;
 
-
 export const ADDRESS_FRAGMENT = gql`
     fragment Address on Address {
         id

diff --git a/packages/core/e2e/graphql/generated-e2e-admin-types.ts b/packages/core/e2e/graphql/generated-e2e-admin-types.ts
@@ -293,6 +293,8 @@ export type ConfigArgDefinition = {
     __typename?: 'ConfigArgDefinition';
     name: Scalars['String'];
     type: Scalars['String'];
+    label?: Maybe<Scalars['String']>;
+    description?: Maybe<Scalars['String']>;
     config?: Maybe<Scalars['JSON']>;
 };
 
@@ -306,7 +308,6 @@ export type ConfigurableOperation = {
     __typename?: 'ConfigurableOperation';
     code: Scalars['String'];
     args: Array<ConfigArg>;
-    description: Scalars['String'];
 };
 
 export type ConfigurableOperationDefinition = {
@@ -2518,12 +2519,6 @@ export type PromotionListOptions = {
     filter?: Maybe<PromotionFilterParameter>;
 };
 
-export type PromotionOperations = {
-    __typename?: 'PromotionOperations';
-    conditions: Array<ConfigurableOperationDefinition>;
-    actions: Array<ConfigurableOperationDefinition>;
-};
-
 export type PromotionSortParameter = {
     id?: Maybe<SortOrder>;
     createdAt?: Maybe<SortOrder>;
@@ -3825,7 +3820,7 @@ export type RoleFragment = { __typename?: 'Role' } & Pick<
 
 export type ConfigurableOperationFragment = { __typename?: 'ConfigurableOperation' } & Pick<
     ConfigurableOperation,
-    'code' | 'description'
+    'code'
 > & { args: Array<{ __typename?: 'ConfigArg' } & Pick<ConfigArg, 'name' | 'type' | 'value'>> };
 
 export type CollectionFragment = { __typename?: 'Collection' } & Pick<
@@ -4601,14 +4596,23 @@ export type UpdatePromotionMutation = { __typename?: 'Mutation' } & {
     updatePromotion: { __typename?: 'Promotion' } & PromotionFragment;
 };
 
+export type ConfigurableOperationDefFragment = { __typename?: 'ConfigurableOperationDefinition' } & Pick<
+    ConfigurableOperationDefinition,
+    'code' | 'description'
+> & {
+        args: Array<
+            { __typename?: 'ConfigArgDefinition' } & Pick<ConfigArgDefinition, 'name' | 'type' | 'config'>
+        >;
+    };
+
 export type GetAdjustmentOperationsQueryVariables = {};
 
 export type GetAdjustmentOperationsQuery = { __typename?: 'Query' } & {
     promotionActions: Array<
-        { __typename?: 'ConfigurableOperationDefinition' } & ConfigurableOperationFragment
+        { __typename?: 'ConfigurableOperationDefinition' } & ConfigurableOperationDefFragment
     >;
     promotionConditions: Array<
-        { __typename?: 'ConfigurableOperationDefinition' } & ConfigurableOperationFragment
+        { __typename?: 'ConfigurableOperationDefinition' } & ConfigurableOperationDefFragment
     >;
 };
 
@@ -5716,11 +5720,16 @@ export namespace UpdatePromotion {
     export type UpdatePromotion = PromotionFragment;
 }
 
+export namespace ConfigurableOperationDef {
+    export type Fragment = ConfigurableOperationDefFragment;
+    export type Args = NonNullable<ConfigurableOperationDefFragment['args'][0]>;
+}
+
 export namespace GetAdjustmentOperations {
     export type Variables = GetAdjustmentOperationsQueryVariables;
     export type Query = GetAdjustmentOperationsQuery;
-    export type PromotionActions = ConfigurableOperationFragment;
-    export type PromotionConditions = ConfigurableOperationFragment;
+    export type PromotionActions = ConfigurableOperationDefFragment;
+    export type PromotionConditions = ConfigurableOperationDefFragment;
 }
 
 export namespace GetRoles {

diff --git a/packages/core/e2e/graphql/generated-e2e-shop-types.ts b/packages/core/e2e/graphql/generated-e2e-shop-types.ts
@@ -217,6 +217,8 @@ export type ConfigArgDefinition = {
     __typename?: 'ConfigArgDefinition';
     name: Scalars['String'];
     type: Scalars['String'];
+    label?: Maybe<Scalars['String']>;
+    description?: Maybe<Scalars['String']>;
     config?: Maybe<Scalars['JSON']>;
 };
 
@@ -230,7 +232,6 @@ export type ConfigurableOperation = {
     __typename?: 'ConfigurableOperation';
     code: Scalars['String'];
     args: Array<ConfigArg>;
-    description: Scalars['String'];
 };
 
 export type ConfigurableOperationDefinition = {
@@ -1816,12 +1817,6 @@ export type PromotionList = PaginatedList & {
     totalItems: Scalars['Int'];
 };
 
-export type PromotionOperations = {
-    __typename?: 'PromotionOperations';
-    conditions: Array<ConfigurableOperationDefinition>;
-    actions: Array<ConfigurableOperationDefinition>;
-};
-
 export type Query = {
     __typename?: 'Query';
     activeChannel: Channel;

diff --git a/packages/core/e2e/order.e2e-spec.ts b/packages/core/e2e/order.e2e-spec.ts
@@ -1,4 +1,5 @@
 /* tslint:disable:no-non-null-assertion */
+import { LanguageCode } from '@vendure/common/lib/generated-shop-types';
 import gql from 'graphql-tag';
 import path from 'path';
 
@@ -1145,7 +1146,7 @@ describe('Orders resolver', () => {
  */
 const twoStagePaymentMethod = new PaymentMethodHandler({
     code: 'authorize-only-payment-method',
-    description: 'Test Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {
@@ -1170,7 +1171,7 @@ const twoStagePaymentMethod = new PaymentMethodHandler({
  */
 const singleStageRefundablePaymentMethod = new PaymentMethodHandler({
     code: 'single-stage-refundable-payment-method',
-    description: 'Test Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {
@@ -1197,7 +1198,7 @@ const singleStageRefundablePaymentMethod = new PaymentMethodHandler({
  */
 const failsToSettlePaymentMethod = new PaymentMethodHandler({
     code: 'fails-to-settle-payment-method',
-    description: 'Test Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {

diff --git a/packages/core/e2e/promotion.e2e-spec.ts b/packages/core/e2e/promotion.e2e-spec.ts
@@ -2,6 +2,7 @@ import { pick } from '@vendure/common/lib/pick';
 import gql from 'graphql-tag';
 import path from 'path';
 
+import { LanguageCode } from '../../common/lib/generated-types';
 import { PromotionAction, PromotionOrderAction } from '../src/config/promotion/promotion-action';
 import { PromotionCondition } from '../src/config/promotion/promotion-condition';
 
@@ -191,7 +192,7 @@ describe('Promotion resolver', () => {
 function generateTestCondition(code: string): PromotionCondition<any> {
     return new PromotionCondition({
         code,
-        description: `description for ${code}`,
+        description: [{ languageCode: LanguageCode.en, value: `description for ${code}` }],
         args: { arg: { type: 'int' } },
         check: (order, args) => true,
     });
@@ -200,7 +201,7 @@ function generateTestCondition(code: string): PromotionCondition<any> {
 function generateTestAction(code: string): PromotionAction<any> {
     return new PromotionOrderAction({
         code,
-        description: `description for ${code}`,
+        description: [{ languageCode: LanguageCode.en, value: `description for ${code}` }],
         args: { facetValueIds: { type: 'facetValueIds' } },
         execute: (order, args) => {
             return 42;

diff --git a/packages/core/e2e/shop-order.e2e-spec.ts b/packages/core/e2e/shop-order.e2e-spec.ts
@@ -9,6 +9,7 @@ import {
     GetCountryList,
     GetCustomer,
     GetCustomerList,
+    LanguageCode,
     UpdateCountry,
 } from './graphql/generated-e2e-admin-types';
 import {
@@ -868,7 +869,7 @@ describe('Shop orders', () => {
 
 const testPaymentMethod = new PaymentMethodHandler({
     code: 'test-payment-method',
-    description: 'Test Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {
@@ -885,7 +886,7 @@ const testPaymentMethod = new PaymentMethodHandler({
 
 const testFailingPaymentMethod = new PaymentMethodHandler({
     code: 'test-failing-payment-method',
-    description: 'Test Failing Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Failing Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {
@@ -901,7 +902,7 @@ const testFailingPaymentMethod = new PaymentMethodHandler({
 
 const testErrorPaymentMethod = new PaymentMethodHandler({
     code: 'test-error-payment-method',
-    description: 'Test Error Payment Method',
+    description: [{ languageCode: LanguageCode.en, value: 'Test Error Payment Method' }],
     args: {},
     createPayment: (order, args, metadata) => {
         return {
-Original file line number
+Diff line change
@@ Expand Up / @@ -149,7 +149,6 @@ export const CONFIGURABLE_FRAGMENT = gql` @@
                 value
             }
             code
-            description
         }
     `;
@@ Expand Down Expand Up / @@ -239,7 +238,6 @@ export const COUNTRY_FRAGMENT = gql` @@
         }
     `;
     export const ADDRESS_FRAGMENT = gql`
         fragment Address on Address {
             id
@@ Expand Down @@