refactor: Use an enum for ConfigArgType, add it to input object

admin-ui/src/app/catalog/components/collection-detail/collection-detail.component.ts

@@ -241,6 +241,7 @@ export class CollectionDetailComponent extends BaseDetailComponent<Collection.Fr
                 arguments: Object.values(formValueOperations[i].args).map((value, j) => ({
                     name: o.args[j].name,
                     value: value.toString(),
+                    type: o.args[j].type,
                 })),
             };
         });

admin-ui/src/app/common/utilities/interpolate-description.spec.ts

@@ -1,11 +1,11 @@
-import { ConfigurableOperation } from 'shared/generated-types';
+import { ConfigArgType, ConfigurableOperation } from 'shared/generated-types';
 
 import { interpolateDescription } from './interpolate-description';
 
 describe('interpolateDescription()', () => {
     it('works for single argument', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'foo', type: 'string' }],
+            args: [{ name: 'foo', type: ConfigArgType.STRING }],
             description: 'The value is { foo }',
         };
         const result = interpolateDescription(operation as any, { foo: 'val' });
@@ -15,7 +15,7 @@ describe('interpolateDescription()', () => {
 
     it('works for multiple arguments', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'foo', type: 'string' }, { name: 'bar', type: 'string' }],
+            args: [{ name: 'foo', type: ConfigArgType.STRING }, { name: 'bar', type: ConfigArgType.STRING }],
             description: 'The value is { foo } and { bar }',
         };
         const result = interpolateDescription(operation as any, { foo: 'val1', bar: 'val2' });
@@ -25,7 +25,7 @@ describe('interpolateDescription()', () => {
 
     it('is case-insensitive', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'foo', type: 'string' }],
+            args: [{ name: 'foo', type: ConfigArgType.STRING }],
             description: 'The value is { FOo }',
         };
         const result = interpolateDescription(operation as any, { foo: 'val' });
@@ -35,7 +35,7 @@ describe('interpolateDescription()', () => {
 
     it('ignores whitespaces in interpolation', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'foo', type: 'string' }, { name: 'bar', type: 'string' }],
+            args: [{ name: 'foo', type: ConfigArgType.STRING }, { name: 'bar', type: ConfigArgType.STRING }],
             description: 'The value is {foo} and {      bar    }',
         };
         const result = interpolateDescription(operation as any, { foo: 'val1', bar: 'val2' });
@@ -45,7 +45,7 @@ describe('interpolateDescription()', () => {
 
     it('formats money as a decimal', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'price', type: 'money' }],
+            args: [{ name: 'price', type: ConfigArgType.MONEY }],
             description: 'The price is { price }',
         };
         const result = interpolateDescription(operation as any, { price: 1234 });
@@ -55,7 +55,7 @@ describe('interpolateDescription()', () => {
 
     it('formats Date object as human-readable', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'date', type: 'datetime' }],
+            args: [{ name: 'date', type: ConfigArgType.DATETIME }],
             description: 'The date is { date }',
         };
         const date = new Date('2017-09-15 00:00:00');
@@ -66,7 +66,7 @@ describe('interpolateDescription()', () => {
 
     it('formats date string object as human-readable', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'date', type: 'datetime' }],
+            args: [{ name: 'date', type: ConfigArgType.DATETIME }],
             description: 'The date is { date }',
         };
         const date = '2017-09-15';
@@ -77,7 +77,7 @@ describe('interpolateDescription()', () => {
 
     it('correctly interprets falsy-looking values', () => {
         const operation: Partial<ConfigurableOperation> = {
-            args: [{ name: 'foo', type: 'int' }],
+            args: [{ name: 'foo', type: ConfigArgType.INT }],
             description: 'The value is { foo }',
         };
         const result = interpolateDescription(operation as any, { foo: 0 });

admin-ui/src/app/common/utilities/interpolate-description.ts

@@ -1,4 +1,4 @@
-import { ConfigurableOperation } from 'shared/generated-types';
+import { ConfigArgType, ConfigurableOperation } from 'shared/generated-types';
 
 /**
  * Interpolates the description of an ConfigurableOperation with the given values.
@@ -19,10 +19,10 @@ export function interpolateDescription(
         }
         let formatted = value;
         const argDef = operation.args.find(arg => arg.name === normalizedArgName);
-        if (argDef && argDef.type === 'money') {
+        if (argDef && argDef.type === ConfigArgType.MONEY) {
             formatted = value / 100;
         }
-        if (argDef && argDef.type === 'datetime' && value instanceof Date) {
+        if (argDef && argDef.type === ConfigArgType.DATETIME && value instanceof Date) {
             formatted = value.toLocaleDateString();
         }
         return formatted;

admin-ui/src/app/marketing/components/promotion-detail/promotion-detail.component.ts

@@ -196,6 +196,7 @@ export class PromotionDetailComponent extends BaseDetailComponent<Promotion.Frag
                 arguments: Object.values(formValueOperations[i].args).map((value, j) => ({
                     name: o.args[j].name,
                     value: value.toString(),
+                    type: o.args[j].type,
                 })),
             };
         });

admin-ui/src/app/settings/components/payment-method-detail/payment-method-detail.component.ts

@@ -1,14 +1,8 @@
 import { ChangeDetectionStrategy, ChangeDetectorRef, Component, OnDestroy, OnInit } from '@angular/core';
-import { FormArray, FormBuilder, FormGroup, Validators } from '@angular/forms';
+import { FormBuilder, FormGroup, Validators } from '@angular/forms';
 import { ActivatedRoute, Router } from '@angular/router';
 import { mergeMap, take } from 'rxjs/operators';
-import {
-    ConfigArg,
-    ConfigurableOperation,
-    ConfigurableOperationInput,
-    PaymentMethod,
-    UpdatePaymentMethodInput,
-} from 'shared/generated-types';
+import { ConfigArg, ConfigArgType, PaymentMethod, UpdatePaymentMethodInput } from 'shared/generated-types';
 
 import { BaseDetailComponent } from '../../../common/base-detail.component';
 import { _ } from '../../../core/providers/i18n/mark-for-extraction';
@@ -55,15 +49,16 @@ export class PaymentMethodDetailComponent extends BaseDetailComponent<PaymentMet
         this.entity$
             .pipe(
                 take(1),
-                mergeMap(({ id }) => {
+                mergeMap(({ id, configArgs }) => {
                     const formValue = this.detailForm.value;
                     const input: UpdatePaymentMethodInput = {
                         id,
                         code: formValue.code,
                         enabled: formValue.enabled,
-                        configArgs: Object.entries(formValue.configArgs).map(([name, value]) => ({
+                        configArgs: Object.entries(formValue.configArgs).map(([name, value], i) => ({
                             name,
                             value: value.toString(),
+                            type: configArgs[i].type,
                         })),
                     };
                     return this.dataService.settings.updatePaymentMethod(input);
@@ -105,9 +100,9 @@ export class PaymentMethodDetailComponent extends BaseDetailComponent<PaymentMet
 
     private parseArgValue(arg: ConfigArg): string | number | boolean {
         switch (arg.type) {
-            case 'int':
+            case ConfigArgType.INT:
                 return Number.parseInt(arg.value || '0', 10);
-            case 'boolean':
+            case ConfigArgType.BOOLEAN:
                 return arg.value === 'false' ? false : true;
             default:
                 return arg.value || '';

admin-ui/src/app/settings/components/shipping-method-detail/shipping-method-detail.component.ts

@@ -147,6 +147,7 @@ export class ShippingMethodDetailComponent extends BaseDetailComponent<ShippingM
             arguments: Object.values(formValueOperations.args || {}).map((value, j) => ({
                 name: operation.args[j].name,
                 value: value.toString(),
+                type: operation.args[j].type,
             })),
         };
     }

admin-ui/src/app/shared/components/configurable-input/configurable-input.component.html

@@ -9,36 +9,36 @@
                     <label [for]="arg.name"></label>
                 </div>
                 <input
-                    *ngIf="arg.type === 'int'"
+                    *ngIf="arg.type === ConfigArgType.INT"
                     [name]="arg.name"
                     type="number"
                     step="1"
                     [formControlName]="arg.name"
                 />
                 <input
-                    *ngIf="arg.type === 'string'"
+                    *ngIf="arg.type === ConfigArgType.STRING"
                     [name]="arg.name"
                     type="text"
                     [formControlName]="arg.name"
                 />
                 <input
-                    *ngIf="arg.type === 'datetime'"
+                    *ngIf="arg.type === ConfigArgType.DATETIME"
                     [name]="arg.name"
                     type="date"
                     [formControlName]="arg.name"
                 />
                 <vdr-currency-input
-                    *ngIf="arg.type === 'money'"
+                    *ngIf="arg.type === ConfigArgType.MONEY"
                     [formControlName]="arg.name"
                 ></vdr-currency-input>
                 <vdr-percentage-suffix-input
-                    *ngIf="arg.type === 'percentage'"
+                    *ngIf="arg.type === ConfigArgType.PERCENTAGE"
                     [formControlName]="arg.name"
                 ></vdr-percentage-suffix-input>
                 <vdr-facet-value-selector
                     [facets]="facets"
                     [formControlName]="arg.name"
-                    *ngIf="arg.type === 'facetValueIds' && facets"
+                    *ngIf="arg.type === ConfigArgType.FACET_VALUE_IDS && facets"
                 ></vdr-facet-value-selector>
             </div>
         </form>

admin-ui/src/app/shared/components/configurable-input/configurable-input.component.ts

@@ -21,7 +21,7 @@ import {
     Validators,
 } from '@angular/forms';
 import { Subscription } from 'rxjs';
-import { ConfigurableOperation, FacetWithValues } from 'shared/generated-types';
+import { ConfigArgType, ConfigurableOperation, FacetWithValues } from 'shared/generated-types';
 
 import { interpolateDescription } from '../../../common/utilities/interpolate-description';
 
@@ -54,6 +54,7 @@ export class ConfigurableInputComponent implements OnChanges, OnDestroy, Control
     onChange: (val: any) => void;
     onTouch: () => void;
     form = new FormGroup({});
+    ConfigArgType = ConfigArgType;
     private subscription: Subscription;
 
     interpolateDescription(): string {

schema.json

@@ -6458,8 +6458,8 @@
               "kind": "NON_NULL",
               "name": null,
               "ofType": {
-                "kind": "SCALAR",
-                "name": "String",
+                "kind": "ENUM",
+                "name": "ConfigArgType",
                 "ofType": null
               }
             },
@@ -6484,6 +6484,59 @@
         "enumValues": null,
         "possibleTypes": null
       },
+      {
+        "kind": "ENUM",
+        "name": "ConfigArgType",
+        "description": "Certain entities allow arbitrary configuration arguments to be specified which can then\nbe set in the admin-ui and used in the business logic of the app. These are the valid\ndata types of such arguments. The data type influences:\n\n1. How the argument form field is rendered in the admin-ui\n2. The JavaScript type into which the value is coerced before being passed to the business logic.",
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "enumValues": [
+          {
+            "name": "PERCENTAGE",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "MONEY",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "INT",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "STRING",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "DATETIME",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "BOOLEAN",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "FACET_VALUE_IDS",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "possibleTypes": null
+      },
       {
         "kind": "OBJECT",
         "name": "CollectionTranslation",
@@ -17226,18 +17279,28 @@
             "defaultValue": null
           },
           {
-            "name": "value",
+            "name": "type",
             "description": null,
             "type": {
               "kind": "NON_NULL",
               "name": null,
               "ofType": {
-                "kind": "SCALAR",
-                "name": "String",
+                "kind": "ENUM",
+                "name": "ConfigArgType",
                 "ofType": null
               }
             },
             "defaultValue": null
+          },
+          {
+            "name": "value",
+            "description": null,
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "defaultValue": null
           }
         ],
         "interfaces": null,

server/e2e/__snapshots__/collection.e2e-spec.ts.snap

@@ -38,7 +38,7 @@ Object {
       "args": Array [
         Object {
           "name": "facetValueIds",
-          "type": "facetValueIds",
+          "type": "FACET_VALUE_IDS",
           "value": "[\\"T_1\\"]",
         },
       ],

server/e2e/__snapshots__/promotion.e2e-spec.ts.snap

@@ -7,7 +7,7 @@ Object {
       "args": Array [
         Object {
           "name": "percentage",
-          "type": "percentage",
+          "type": "PERCENTAGE",
           "value": null,
         },
       ],
@@ -20,7 +20,7 @@ Object {
       "args": Array [
         Object {
           "name": "arg",
-          "type": "money",
+          "type": "MONEY",
           "value": null,
         },
       ],
@@ -31,7 +31,7 @@ Object {
       "args": Array [
         Object {
           "name": "arg",
-          "type": "money",
+          "type": "MONEY",
           "value": null,
         },
       ],
@@ -49,7 +49,7 @@ Object {
       "args": Array [
         Object {
           "name": "percentage",
-          "type": "percentage",
+          "type": "PERCENTAGE",
           "value": "50",
         },
       ],
@@ -62,7 +62,7 @@ Object {
       "args": Array [
         Object {
           "name": "arg",
-          "type": "money",
+          "type": "MONEY",
           "value": "500",
         },
       ],
@@ -82,7 +82,7 @@ Object {
       "args": Array [
         Object {
           "name": "percentage",
-          "type": "percentage",
+          "type": "PERCENTAGE",
           "value": "50",
         },
       ],
@@ -95,7 +95,7 @@ Object {
       "args": Array [
         Object {
           "name": "arg",
-          "type": "money",
+          "type": "MONEY",
           "value": "90",
         },
       ],
@@ -106,7 +106,7 @@ Object {
       "args": Array [
         Object {
           "name": "arg",
-          "type": "money",
+          "type": "MONEY",
           "value": "10",
         },
       ],

server/e2e/collection.e2e-spec.ts

@@ -10,6 +10,7 @@ import {
 } from '../../admin-ui/src/app/data/definitions/product-definitions';
 import {
     Collection,
+    ConfigArgType,
     CreateCollection,
     GetAssetList,
     GetCollection,
@@ -67,7 +68,13 @@ describe('Collection resolver', () => {
                         filters: [
                             {
                                 code: facetValueCollectionFilter.code,
-                                arguments: [{ name: 'facetValueIds', value: `["T_1"]` }],
+                                arguments: [
+                                    {
+                                        name: 'facetValueIds',
+                                        value: `["T_1"]`,
+                                        type: ConfigArgType.FACET_VALUE_IDS,
+                                    },
+                                ],
                             },
                         ],
                         translations: [
@@ -92,7 +99,13 @@ describe('Collection resolver', () => {
                         filters: [
                             {
                                 code: facetValueCollectionFilter.code,
-                                arguments: [{ name: 'facetValueIds', value: `["T_2"]` }],
+                                arguments: [
+                                    {
+                                        name: 'facetValueIds',
+                                        value: `["T_2"]`,
+                                        type: ConfigArgType.FACET_VALUE_IDS,
+                                    },
+                                ],
                             },
                         ],
                     },

server/e2e/promotion.e2e-spec.ts

@@ -9,6 +9,7 @@ import {
     UPDATE_PROMOTION,
 } from '../../admin-ui/src/app/data/definitions/promotion-definitions';
 import {
+    ConfigArgType,
     CreatePromotion,
     DeletionResult,
     GetAdjustmentOperations,
@@ -72,13 +73,13 @@ describe('Promotion resolver', () => {
                     conditions: [
                         {
                             code: promoCondition.code,
-                            arguments: [{ name: 'arg', value: '500' }],
+                            arguments: [{ name: 'arg', value: '500', type: ConfigArgType.MONEY }],
                         },
                     ],
                     actions: [
                         {
                             code: promoAction.code,
-                            arguments: [{ name: 'percentage', value: '50' }],
+                            arguments: [{ name: 'percentage', value: '50', type: ConfigArgType.PERCENTAGE }],
                         },
                     ],
                 },
@@ -97,11 +98,11 @@ describe('Promotion resolver', () => {
                     conditions: [
                         {
                             code: promoCondition.code,
-                            arguments: [{ name: 'arg', value: '90' }],
+                            arguments: [{ name: 'arg', value: '90', type: ConfigArgType.MONEY }],
                         },
                         {
                             code: promoCondition2.code,
-                            arguments: [{ name: 'arg', value: '10' }],
+                            arguments: [{ name: 'arg', value: '10', type: ConfigArgType.MONEY }],
                         },
                     ],
                 },
@@ -187,7 +188,7 @@ function generateTestCondition(code: string): PromotionCondition<any> {
     return new PromotionCondition({
         code,
         description: `description for ${code}`,
-        args: { arg: 'money' },
+        args: { arg: ConfigArgType.MONEY },
         check: (order, args) => true,
     });
 }
@@ -196,7 +197,7 @@ function generateTestAction(code: string): PromotionAction<any> {
     return new PromotionOrderAction({
         code,
         description: `description for ${code}`,
-        args: { percentage: 'percentage' },
+        args: { percentage: ConfigArgType.PERCENTAGE },
         execute: (order, args) => {
             return 42;
         },

server/src/api/resolvers/admin/collection.resolver.ts

@@ -15,6 +15,7 @@ import { CollectionFilter } from '../../../config/collection/collection-filter';
 import { Collection } from '../../../entity/collection/collection.entity';
 import { CollectionService } from '../../../service/services/collection.service';
 import { FacetValueService } from '../../../service/services/facet-value.service';
+import { IdCodecService } from '../../common/id-codec.service';
 import { RequestContext } from '../../common/request-context';
 import { Allow } from '../../decorators/allow.decorator';
 import { Decode } from '../../decorators/decode.decorator';
@@ -22,7 +23,11 @@ import { Ctx } from '../../decorators/request-context.decorator';
 
 @Resolver()
 export class CollectionResolver {
-    constructor(private collectionService: CollectionService, private facetValueService: FacetValueService) {}
+    constructor(
+        private collectionService: CollectionService,
+        private facetValueService: FacetValueService,
+        private idCodecService: IdCodecService,
+    ) {}
 
     @Query()
     @Allow(Permission.ReadCatalog)
@@ -53,7 +58,7 @@ export class CollectionResolver {
 
     @Mutation()
     @Allow(Permission.CreateCatalog)
-    @Decode('assetIds', 'featuredAssetId', 'parentId', 'facetValueIds')
+    @Decode('assetIds', 'featuredAssetId', 'parentId')
     async createCollection(
         @Ctx() ctx: RequestContext,
         @Args() args: CreateCollectionMutationArgs,
@@ -64,7 +69,7 @@ export class CollectionResolver {
 
     @Mutation()
     @Allow(Permission.UpdateCatalog)
-    @Decode('assetIds', 'featuredAssetId', 'facetValueIds')
+    @Decode('assetIds', 'featuredAssetId')
     async updateCollection(
         @Ctx() ctx: RequestContext,
         @Args() args: UpdateCollectionMutationArgs,

server/src/api/schema/common/common-types.graphql

@@ -20,9 +20,28 @@ type Adjustment {
     amount: Int!
 }
 
+"""
+Certain entities allow arbitrary configuration arguments to be specified which can then
+be set in the admin-ui and used in the business logic of the app. These are the valid
+data types of such arguments. The data type influences:
+
+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.
+
+"""
+enum ConfigArgType {
+    PERCENTAGE
+    MONEY
+    INT
+    STRING
+    DATETIME
+    BOOLEAN
+    FACET_VALUE_IDS
+}
+
 type ConfigArg {
     name: String!
-    type: String!
+    type: ConfigArgType!
     value: String
 }
 
@@ -46,7 +65,8 @@ type DeletionResponse {
 
 input ConfigArgInput {
     name: String!
-    value: String!
+    type: ConfigArgType!
+    value: String
 }
 
 input ConfigurableOperationInput {

server/src/common/configurable-operation.ts

@@ -1,24 +1,8 @@
 // prettier-ignore
-import { ConfigArg, ConfigurableOperation } from '../../../shared/generated-types';
+import { ConfigArg, ConfigArgType, ConfigurableOperation } from '../../../shared/generated-types';
 
 import { InternalServerError } from './error/errors';
 
-/**
- * Certain entities allow arbitrary configuration arguments to be specified which can then
- * be set in the admin-ui and used in the business logic of the app. These are the valid
- * data types of such arguments. The data type influences:
- * 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 =
-    | 'percentage'
-    | 'money'
-    | 'int'
-    | 'string'
-    | 'datetime'
-    | 'boolean'
-    | 'facetValueIds';
-
 export type ConfigArgs<T extends ConfigArgType> = {
     [name: string]: T;
 };
@@ -28,13 +12,13 @@ export type ConfigArgs<T extends ConfigArgType> = {
  * in business logic.
  */
 export type ConfigArgValues<T extends ConfigArgs<any>> = {
-    [K in keyof T]: T[K] extends 'int' | 'money' | 'percentage'
+    [K in keyof T]: T[K] extends ConfigArgType.INT | ConfigArgType.MONEY | ConfigArgType.PERCENTAGE
         ? number
-        : T[K] extends 'datetime'
+        : T[K] extends ConfigArgType.DATETIME
         ? Date
-        : T[K] extends 'boolean'
+        : T[K] extends ConfigArgType.BOOLEAN
         ? boolean
-        : T[K] extends 'facetValueIds'
+        : T[K] extends ConfigArgType.FACET_VALUE_IDS
         ? string[]
         : string
 };
@@ -82,14 +66,18 @@ export function argsArrayToHash<T>(args: ConfigArg[]): ConfigArgValues<T> {
 
 function coerceValueToType<T>(arg: ConfigArg): ConfigArgValues<T>[keyof T] {
     switch (arg.type as ConfigArgType) {
-        case 'int':
-        case 'money':
+        case ConfigArgType.STRING:
+            return arg.value as any;
+        case ConfigArgType.INT:
+        case ConfigArgType.MONEY:
             return Number.parseInt(arg.value || '', 10) as any;
-        case 'datetime':
+        case ConfigArgType.DATETIME:
             return Date.parse(arg.value || '') as any;
-        case 'boolean':
+        case ConfigArgType.BOOLEAN:
             return !!arg.value as any;
-        case 'facetValueIds':
+        case ConfigArgType.PERCENTAGE:
+            return arg.value as any;
+        case ConfigArgType.FACET_VALUE_IDS:
             try {
                 return JSON.parse(arg.value as any);
             } catch (err) {

server/src/config/collection/collection-filter.ts

@@ -1,6 +1,6 @@
 import { SelectQueryBuilder } from 'typeorm';
 
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 import {
     argsArrayToHash,
     ConfigArgs,
@@ -9,7 +9,7 @@ import {
 } from '../../common/configurable-operation';
 import { ProductVariant } from '../../entity/product-variant/product-variant.entity';
 
-export type CollectionFilterArgType = 'facetValueIds';
+export type CollectionFilterArgType = ConfigArgType.FACET_VALUE_IDS;
 export type CollectionFilterArgs = ConfigArgs<CollectionFilterArgType>;
 
 export type ApplyCollectionFilterFn<T extends CollectionFilterArgs> = (

server/src/config/collection/default-collection-filters.ts

@@ -1,5 +1,7 @@
 import { Brackets } from 'typeorm';
 
+import { ConfigArgType } from '../../../../shared/generated-types';
+
 import { CollectionFilter } from './collection-filter';
 
 /**
@@ -7,7 +9,7 @@ import { CollectionFilter } from './collection-filter';
  */
 export const facetValueCollectionFilter = new CollectionFilter({
     args: {
-        facetValueIds: 'facetValueIds',
+        facetValueIds: ConfigArgType.FACET_VALUE_IDS,
     },
     code: 'facet-value-filter',
     description: 'Filter by FacetValues',

server/src/config/payment-method/example-payment-method-config.ts

@@ -1,3 +1,5 @@
+import { ConfigArgType } from '../../../../shared/generated-types';
+
 import { PaymentConfig, PaymentMethodHandler } from './payment-method-handler';
 
 /**
@@ -23,7 +25,7 @@ export const examplePaymentHandler = new PaymentMethodHandler({
     code: 'example-payment-provider',
     name: 'Example Payment Provider',
     args: {
-        apiKey: 'string',
+        apiKey: ConfigArgType.STRING,
     },
     createPayment: async (order, args, metadata): Promise<PaymentConfig> => {
         try {

server/src/config/payment-method/payment-method-handler.ts

@@ -1,4 +1,4 @@
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 
 import { argsArrayToHash, ConfigArgs, ConfigArgValues } from '../../common/configurable-operation';
 import { StateMachineConfig } from '../../common/finite-state-machine';
@@ -9,7 +9,7 @@ import {
     PaymentTransitionData,
 } from '../../service/helpers/payment-state-machine/payment-state';
 
-export type PaymentMethodArgType = 'int' | 'string' | 'boolean';
+export type PaymentMethodArgType = ConfigArgType.INT | ConfigArgType.STRING | ConfigArgType.BOOLEAN;
 export type PaymentMethodArgs = ConfigArgs<PaymentMethodArgType>;
 export type OnTransitionStartReturnType = ReturnType<Required<StateMachineConfig<any>>['onTransitionStart']>;
 
@@ -134,6 +134,7 @@ export interface PaymentMethodConfigOptions<T extends PaymentMethodArgs = Paymen
  *     },
  * });
  * ```
+ * // TODO: Refactor to implement ConfigurableOperationDef interface
  *
  * @docsCategory payment
  */

server/src/config/promotion/default-promotion-actions.ts

@@ -1,8 +1,10 @@
-import { PromotionAction, PromotionItemAction, PromotionOrderAction } from './promotion-action';
+import { ConfigArgType } from '../../../../shared/generated-types';
+
+import { PromotionItemAction, PromotionOrderAction } from './promotion-action';
 
 export const orderPercentageDiscount = new PromotionOrderAction({
     code: 'order_percentage_discount',
-    args: { discount: 'percentage' },
+    args: { discount: ConfigArgType.PERCENTAGE },
     execute(order, args) {
         return -order.subTotal * (args.discount / 100);
     },
@@ -11,7 +13,7 @@ export const orderPercentageDiscount = new PromotionOrderAction({
 
 export const itemPercentageDiscount = new PromotionItemAction({
     code: 'item_percentage_discount',
-    args: { discount: 'percentage' },
+    args: { discount: ConfigArgType.PERCENTAGE },
     execute(orderItem, orderLine, args) {
         return -orderLine.unitPrice * (args.discount / 100);
     },
@@ -35,7 +37,7 @@ export const buy1Get1Free = new PromotionItemAction({
 
 export const discountOnItemWithFacets = new PromotionItemAction({
     code: 'facet_based_discount',
-    args: { discount: 'percentage', facets: 'facetValueIds' },
+    args: { discount: ConfigArgType.PERCENTAGE, facets: ConfigArgType.FACET_VALUE_IDS },
     async execute(orderItem, orderLine, args, { hasFacetValues }) {
         if (await hasFacetValues(orderLine, args.facets)) {
             return -orderLine.unitPrice * (args.discount / 100);

server/src/config/promotion/default-promotion-conditions.ts

@@ -1,3 +1,4 @@
+import { ConfigArgType } from '../../../../shared/generated-types';
 import { Order } from '../../entity/order/order.entity';
 
 import { PromotionCondition } from './promotion-condition';
@@ -6,8 +7,8 @@ export const minimumOrderAmount = new PromotionCondition({
     description: 'If order total is greater than { amount }',
     code: 'minimum_order_amount',
     args: {
-        amount: 'money',
-        taxInclusive: 'boolean',
+        amount: ConfigArgType.MONEY,
+        taxInclusive: ConfigArgType.BOOLEAN,
     },
     check(order, args) {
         if (args.taxInclusive) {
@@ -22,7 +23,7 @@ export const minimumOrderAmount = new PromotionCondition({
 export const dateRange = new PromotionCondition({
     code: 'date_range',
     description: 'If Order placed between { start } and { end }',
-    args: { start: 'datetime', end: 'datetime' },
+    args: { start: ConfigArgType.DATETIME, end: ConfigArgType.DATETIME },
     check(order: Order, args) {
         const now = new Date();
         return args.start < now && now < args.end;
@@ -32,7 +33,7 @@ export const dateRange = new PromotionCondition({
 export const atLeastNOfProduct = new PromotionCondition({
     code: 'at_least_n_of_product',
     description: 'Buy at least { minimum } of any product',
-    args: { minimum: 'int' },
+    args: { minimum: ConfigArgType.INT },
     check(order: Order, args) {
         return order.lines.reduce((result, item) => {
             return result || item.quantity >= args.minimum;
@@ -43,7 +44,7 @@ export const atLeastNOfProduct = new PromotionCondition({
 export const atLeastNWithFacets = new PromotionCondition({
     code: 'at_least_n_with_facets',
     description: 'Buy at least { minimum } products with the given facets',
-    args: { minimum: 'int', facets: 'facetValueIds' },
+    args: { minimum: ConfigArgType.INT, facets: ConfigArgType.FACET_VALUE_IDS },
     async check(order: Order, args, { hasFacetValues }) {
         let matches = 0;
         for (const line of order.lines) {

server/src/config/promotion/promotion-action.ts

@@ -1,4 +1,4 @@
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 import {
     argsArrayToHash,
     ConfigArgs,
@@ -11,7 +11,11 @@ import { Order } from '../../entity/order/order.entity';
 
 import { PromotionUtils } from './promotion-condition';
 
-export type PromotionActionArgType = 'percentage' | 'money' | 'int' | 'facetValueIds';
+export type PromotionActionArgType =
+    | ConfigArgType.PERCENTAGE
+    | ConfigArgType.MONEY
+    | ConfigArgType.INT
+    | ConfigArgType.FACET_VALUE_IDS;
 export type PromotionActionArgs = ConfigArgs<PromotionActionArgType>;
 
 export type ExecutePromotionItemActionFn<T extends PromotionActionArgs> = (

server/src/config/promotion/promotion-condition.ts

@@ -1,4 +1,4 @@
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 
 import { ID } from '../../../../shared/shared-types';
 import {
@@ -10,7 +10,13 @@ import {
 import { OrderLine } from '../../entity';
 import { Order } from '../../entity/order/order.entity';
 
-export type PromotionConditionArgType = 'int' | 'money' | 'string' | 'datetime' | 'boolean' | 'facetValueIds';
+export type PromotionConditionArgType =
+    | ConfigArgType.INT
+    | ConfigArgType.MONEY
+    | ConfigArgType.STRING
+    | ConfigArgType.DATETIME
+    | ConfigArgType.BOOLEAN
+    | ConfigArgType.FACET_VALUE_IDS;
 export type PromotionConditionArgs = ConfigArgs<PromotionConditionArgType>;
 
 /**

server/src/config/shipping-method/default-shipping-calculator.ts

@@ -1,10 +1,12 @@
+import { ConfigArgType } from '../../../../shared/generated-types';
+
 import { ShippingCalculator } from './shipping-calculator';
 
 export const defaultShippingCalculator = new ShippingCalculator({
     code: 'default-shipping-calculator',
     description: 'Default Flat-Rate Shipping Calculator',
     args: {
-        rate: 'money',
+        rate: ConfigArgType.MONEY,
     },
     calculate: (order, args) => {
         return args.rate;

server/src/config/shipping-method/shipping-calculator.ts

@@ -1,10 +1,14 @@
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 
 import { ConfigArgs, ConfigurableOperationDef } from '../../common/configurable-operation';
 import { argsArrayToHash, ConfigArgValues } from '../../common/configurable-operation';
 import { Order } from '../../entity/order/order.entity';
 
-export type ShippingCalculatorArgType = 'int' | 'money' | 'string' | 'boolean';
+export type ShippingCalculatorArgType =
+    | ConfigArgType.INT
+    | ConfigArgType.MONEY
+    | ConfigArgType.STRING
+    | ConfigArgType.BOOLEAN;
 export type ShippingCalculatorArgs = ConfigArgs<ShippingCalculatorArgType>;
 export type CalculateShippingFn<T extends ShippingCalculatorArgs> = (
     order: Order,

server/src/config/shipping-method/shipping-eligibility-checker.ts

@@ -1,10 +1,14 @@
-import { ConfigArg } from '../../../../shared/generated-types';
+import { ConfigArg, ConfigArgType } from '../../../../shared/generated-types';
 
 import { ConfigArgs, ConfigurableOperationDef } from '../../common/configurable-operation';
 import { argsArrayToHash, ConfigArgValues } from '../../common/configurable-operation';
 import { Order } from '../../entity/order/order.entity';
 
-export type ShippingEligibilityCheckerArgType = 'int' | 'money' | 'string' | 'boolean';
+export type ShippingEligibilityCheckerArgType =
+    | ConfigArgType.INT
+    | ConfigArgType.MONEY
+    | ConfigArgType.STRING
+    | ConfigArgType.BOOLEAN;
 export type ShippingEligibilityCheckerArgs = ConfigArgs<ShippingEligibilityCheckerArgType>;
 export type CheckShippingEligibilityCheckerFn<T extends ShippingEligibilityCheckerArgs> = (
     order: Order,

server/src/data-import/providers/populator/populator.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 
-import { LanguageCode } from '../../../../../shared/generated-types';
+import { ConfigArgType, LanguageCode } from '../../../../../shared/generated-types';
 import { normalizeString } from '../../../../../shared/normalize-string';
 import { RequestContext } from '../../../api/common/request-context';
 import { defaultShippingCalculator, defaultShippingEligibilityChecker } from '../../../config';
@@ -135,7 +135,7 @@ export class Populator {
                 },
                 calculator: {
                     code: defaultShippingCalculator.code,
-                    arguments: [{ name: 'rate', value: method.price.toString() }],
+                    arguments: [{ name: 'rate', value: method.price.toString(), type: ConfigArgType.MONEY }],
                 },
                 description: method.name,
                 code: normalizeString(method.name, '-'),

server/src/service/helpers/order-calculator/order-calculator.spec.ts

@@ -1,8 +1,9 @@
 import { Test } from '@nestjs/testing';
 import { Connection } from 'typeorm';
 
+import { ConfigArgType } from '../../../../../shared/generated-types';
 import { Omit } from '../../../../../shared/omit';
-import { PromotionAction, PromotionItemAction, PromotionOrderAction } from '../../../config';
+import { PromotionItemAction, PromotionOrderAction } from '../../../config';
 import { ConfigService } from '../../../config/config.service';
 import { MockConfigService } from '../../../config/config.service.mock';
 import { PromotionCondition } from '../../../config/promotion/promotion-condition';
@@ -135,7 +136,7 @@ describe('OrderCalculator', () => {
         });
 
         const orderTotalCondition = new PromotionCondition({
-            args: { minimum: 'money' },
+            args: { minimum: ConfigArgType.MONEY },
             code: 'order_total_condition',
             description: '',
             check(order, args) {
@@ -187,7 +188,7 @@ describe('OrderCalculator', () => {
                 conditions: [
                     {
                         code: orderTotalCondition.code,
-                        args: [{ name: 'minimum', type: 'money', value: '100' }],
+                        args: [{ name: 'minimum', type: ConfigArgType.MONEY, value: '100' }],
                     },
                 ],
                 promotionConditions: [orderTotalCondition],
@@ -219,7 +220,7 @@ describe('OrderCalculator', () => {
 
         it('interaction between promotions', async () => {
             const orderQuantityCondition = new PromotionCondition({
-                args: { minimum: 'int' },
+                args: { minimum: ConfigArgType.INT },
                 code: 'order_quantity_condition',
                 description: 'Passes if any order line has at least the minimum quantity',
                 check(_order, args) {
@@ -234,7 +235,7 @@ describe('OrderCalculator', () => {
 
             const orderPercentageDiscount = new PromotionOrderAction({
                 code: 'order_percentage_discount',
-                args: { discount: 'percentage' },
+                args: { discount: ConfigArgType.PERCENTAGE },
                 execute(_order, args) {
                     return -_order.subTotal * (args.discount / 100);
                 },
@@ -247,14 +248,14 @@ describe('OrderCalculator', () => {
                 conditions: [
                     {
                         code: orderQuantityCondition.code,
-                        args: [{ name: 'minimum', type: 'int', value: '3' }],
+                        args: [{ name: 'minimum', type: ConfigArgType.INT, value: '3' }],
                     },
                 ],
                 promotionConditions: [orderQuantityCondition],
                 actions: [
                     {
                         code: orderPercentageDiscount.code,
-                        args: [{ name: 'discount', type: 'percentage', value: '50' }],
+                        args: [{ name: 'discount', type: ConfigArgType.PERCENTAGE, value: '50' }],
                     },
                 ],
                 promotionActions: [orderPercentageDiscount],
@@ -266,14 +267,14 @@ describe('OrderCalculator', () => {
                 conditions: [
                     {
                         code: orderTotalCondition.code,
-                        args: [{ name: 'minimum', type: 'money', value: '100' }],
+                        args: [{ name: 'minimum', type: ConfigArgType.MONEY, value: '100' }],
                     },
                 ],
                 promotionConditions: [orderTotalCondition],
                 actions: [
                     {
                         code: orderPercentageDiscount.code,
-                        args: [{ name: 'discount', type: 'percentage', value: '10' }],
+                        args: [{ name: 'discount', type: ConfigArgType.PERCENTAGE, value: '10' }],
                     },
                 ],
                 promotionActions: [orderPercentageDiscount],

server/src/service/services/payment-method.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { InjectConnection } from '@nestjs/typeorm';
 import { Connection } from 'typeorm';
 
-import { UpdatePaymentMethodInput } from '../../../../shared/generated-types';
+import { ConfigArgType, UpdatePaymentMethodInput } from '../../../../shared/generated-types';
 import { omit } from '../../../../shared/omit';
 import { ID, PaginatedList } from '../../../../shared/shared-types';
 import { assertNever } from '../../../../shared/shared-utils';
@@ -120,11 +120,11 @@ export class PaymentMethodService {
 
     private getDefaultValue(type: PaymentMethodArgType): string {
         switch (type) {
-            case 'string':
+            case ConfigArgType.STRING:
                 return '';
-            case 'boolean':
+            case ConfigArgType.BOOLEAN:
                 return 'false';
-            case 'int':
+            case ConfigArgType.INT:
                 return '0';
             default:
                 assertNever(type);

shared/generated-shop-types.ts

@@ -1,5 +1,5 @@
 // tslint:disable
-// Generated in 2019-03-05T20:52:07+01:00
+// Generated in 2019-03-06T10:36:47+01:00
 export type Maybe<T> = T | null;
 
 export interface OrderListOptions {
@@ -349,7 +349,9 @@ export interface UpdateAddressInput {
 export interface ConfigArgInput {
     name: string;
 
-    value: string;
+    type: ConfigArgType;
+
+    value?: Maybe<string>;
 }
 
 export interface ConfigurableOperationInput {
@@ -725,6 +727,16 @@ export enum AdjustmentType {
     PROMOTION_REFUND = 'PROMOTION_REFUND',
     SHIPPING_REFUND = 'SHIPPING_REFUND',
 }
+/** Certain entities allow arbitrary configuration arguments to be specified which can then be set in the admin-ui and used in the business logic of the app. These are the valid data types of such arguments. The data type influences: 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 enum ConfigArgType {
+    PERCENTAGE = 'PERCENTAGE',
+    MONEY = 'MONEY',
+    INT = 'INT',
+    STRING = 'STRING',
+    DATETIME = 'DATETIME',
+    BOOLEAN = 'BOOLEAN',
+    FACET_VALUE_IDS = 'FACET_VALUE_IDS',
+}
 /** Permissions for administrators and customers */
 export enum Permission {
     Authenticated = 'Authenticated',
@@ -1282,7 +1294,7 @@ export interface ConfigurableOperation {
 export interface ConfigArg {
     name: string;
 
-    type: string;
+    type: ConfigArgType;
 
     value?: Maybe<string>;
 }

shared/generated-types.ts

@@ -1,5 +1,5 @@
 // tslint:disable
-// Generated in 2019-03-05T20:52:08+01:00
+// Generated in 2019-03-06T10:36:48+01:00
 export type Maybe<T> = T | null;
 
 
@@ -730,7 +730,9 @@ export interface ConfigArgInput {
   
   name: string;
   
-  value: string;
+  type: ConfigArgType;
+  
+  value?: Maybe<string>;
 }
 
 export interface CollectionTranslationInput {
@@ -1653,6 +1655,16 @@ export interface ProductOptionTranslationInput {
     VIDEO = "VIDEO",
     BINARY = "BINARY",
   }
+/** Certain entities allow arbitrary configuration arguments to be specified which can then be set in the admin-ui and used in the business logic of the app. These are the valid data types of such arguments. The data type influences: 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 enum ConfigArgType {
+    PERCENTAGE = "PERCENTAGE",
+    MONEY = "MONEY",
+    INT = "INT",
+    STRING = "STRING",
+    DATETIME = "DATETIME",
+    BOOLEAN = "BOOLEAN",
+    FACET_VALUE_IDS = "FACET_VALUE_IDS",
+  }
 
   export enum AdjustmentType {
     TAX = "TAX",
@@ -4200,7 +4212,7 @@ export namespace ConfigurableOperation {
     
     name: string;
     
-    type: string;
+    type: ConfigArgType;
     
     value: Maybe<string>;
   }
@@ -4380,7 +4392,7 @@ export namespace PaymentMethod {
     
     name: string;
     
-    type: string;
+    type: ConfigArgType;
     
     value: Maybe<string>;
   }
@@ -4783,7 +4795,7 @@ export interface ConfigArg {
   
   name: string;
   
-  type: string;
+  type: ConfigArgType;
   
   value?: Maybe<string>;
 }