feat(admin-ui): Allow setting FulfillmentHandler in ShippingDetail page

Relates to #529
vendure-ecommerce · Nov 26, 2020 · 8207c84 · 8207c84
1 parent b852e9d
commit 8207c84
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 16 deletions.
diff --git a/packages/admin-ui/src/lib/core/src/common/generated-types.ts b/packages/admin-ui/src/lib/core/src/common/generated-types.ts
@@ -41,6 +41,7 @@ export type Query = {
   customers: CustomerList;
   facet?: Maybe<Facet>;
   facets: FacetList;
+  fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
   globalSettings: GlobalSettings;
   job?: Maybe<Job>;
   jobQueues: Array<JobQueue>;
@@ -1306,7 +1307,7 @@ export type UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguage
 /**
  * @description
  * The state of a Job in the JobQueue
- * 
+ *
  * @docsCategory common
  */
 export enum JobState {
@@ -1399,8 +1400,7 @@ export type UpdateOrderInput = {
 
 export type FulfillOrderInput = {
   lines: Array<OrderLineInput>;
-  method: Scalars['String'];
-  trackingCode?: Maybe<Scalars['String']>;
+  handler: ConfigurableOperationInput;
 };
 
 export type CancelOrderInput = {
@@ -1463,6 +1463,21 @@ export type ItemsAlreadyFulfilledError = ErrorResult & {
   message: Scalars['String'];
 };
 
+/** Returned if the specified FulfillmentHandler code is not valid */
+export type InvalidFulfillmentHandlerError = ErrorResult & {
+  __typename?: 'InvalidFulfillmentHandlerError';
+  errorCode: ErrorCode;
+  message: Scalars['String'];
+};
+
+/** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
+export type CreateFulfillmentError = ErrorResult & {
+  __typename?: 'CreateFulfillmentError';
+  errorCode: ErrorCode;
+  message: Scalars['String'];
+  fulfillmentHandlerError: Scalars['String'];
+};
+
 /**
  * Returned if attempting to create a Fulfillment when there is insufficient
  * stockOnHand of a ProductVariant to satisfy the requested quantity.
@@ -1562,7 +1577,7 @@ export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
 
 export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError;
 
-export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError;
+export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError;
 
 export type CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError;
 
@@ -1890,6 +1905,7 @@ export type ShippingMethodTranslationInput = {
 
 export type CreateShippingMethodInput = {
   code: Scalars['String'];
+  fulfillmentHandler: Scalars['String'];
   checker: ConfigurableOperationInput;
   calculator: ConfigurableOperationInput;
   translations: Array<ShippingMethodTranslationInput>;
@@ -1899,6 +1915,7 @@ export type CreateShippingMethodInput = {
 export type UpdateShippingMethodInput = {
   id: Scalars['ID'];
   code?: Maybe<Scalars['String']>;
+  fulfillmentHandler?: Maybe<Scalars['String']>;
   checker?: Maybe<ConfigurableOperationInput>;
   calculator?: Maybe<ConfigurableOperationInput>;
   translations: Array<ShippingMethodTranslationInput>;
@@ -2040,7 +2057,7 @@ export enum DeletionResult {
  * @description
  * Permissions for administrators and customers. Used to control access to
  * GraphQL resolvers via the {@link Allow} decorator.
- * 
+ *
  * @docsCategory common
  */
 export enum Permission {
@@ -2141,6 +2158,8 @@ export enum ErrorCode {
   SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
   EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
   ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
+  INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
+  CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
   INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
   MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
   CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
@@ -2305,7 +2324,7 @@ export type EmailAddressConflictError = ErrorResult & {
 /**
  * @description
  * ISO 4217 currency code
- * 
+ *
  * @docsCategory common
  */
 export enum CurrencyCode {
@@ -2739,7 +2758,7 @@ export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFiel
  * region or script modifier (e.g. de_AT). The selection available is based
  * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  * and includes the major spoken languages of the world and any widely-used variants.
- * 
+ *
  * @docsCategory common
  */
 export enum LanguageCode {
@@ -3647,6 +3666,7 @@ export type ShippingMethod = Node & {
   code: Scalars['String'];
   name: Scalars['String'];
   description: Scalars['String'];
+  fulfillmentHandlerCode: Scalars['String'];
   checker: ConfigurableOperation;
   calculator: ConfigurableOperation;
   translations: Array<ShippingMethodTranslation>;
@@ -4198,6 +4218,7 @@ export type ShippingMethodFilterParameter = {
   code?: Maybe<StringOperators>;
   name?: Maybe<StringOperators>;
   description?: Maybe<StringOperators>;
+  fulfillmentHandlerCode?: Maybe<StringOperators>;
 };
 
 export type ShippingMethodSortParameter = {
@@ -4207,6 +4228,7 @@ export type ShippingMethodSortParameter = {
   code?: Maybe<SortOrder>;
   name?: Maybe<SortOrder>;
   description?: Maybe<SortOrder>;
+  fulfillmentHandlerCode?: Maybe<SortOrder>;
 };
 
 export type TaxRateFilterParameter = {
@@ -5284,6 +5306,15 @@ export type CreateFulfillmentMutation = { addFulfillmentToOrder: (
   ) | (
     { __typename?: 'InsufficientStockOnHandError' }
     & ErrorResult_InsufficientStockOnHandError_Fragment
+  ) | (
+    { __typename?: 'InvalidFulfillmentHandlerError' }
+    & ErrorResult_InvalidFulfillmentHandlerError_Fragment
+  ) | (
+    { __typename?: 'FulfillmentStateTransitionError' }
+    & ErrorResult_FulfillmentStateTransitionError_Fragment
+  ) | (
+    { __typename?: 'CreateFulfillmentError' }
+    & ErrorResult_CreateFulfillmentError_Fragment
   ) };
 
 export type CancelOrderMutationVariables = Exact<{
@@ -7045,6 +7076,16 @@ type ErrorResult_ItemsAlreadyFulfilledError_Fragment = (
   & Pick<ItemsAlreadyFulfilledError, 'errorCode' | 'message'>
 );
 
+type ErrorResult_InvalidFulfillmentHandlerError_Fragment = (
+  { __typename?: 'InvalidFulfillmentHandlerError' }
+  & Pick<InvalidFulfillmentHandlerError, 'errorCode' | 'message'>
+);
+
+type ErrorResult_CreateFulfillmentError_Fragment = (
+  { __typename?: 'CreateFulfillmentError' }
+  & Pick<CreateFulfillmentError, 'errorCode' | 'message'>
+);
+
 type ErrorResult_InsufficientStockOnHandError_Fragment = (
   { __typename?: 'InsufficientStockOnHandError' }
   & Pick<InsufficientStockOnHandError, 'errorCode' | 'message'>
@@ -7130,11 +7171,11 @@ type ErrorResult_EmailAddressConflictError_Fragment = (
   & Pick<EmailAddressConflictError, 'errorCode' | 'message'>
 );
 
-export type ErrorResultFragment = ErrorResult_MimeTypeError_Fragment | ErrorResult_LanguageNotAvailableError_Fragment | ErrorResult_ChannelDefaultLanguageError_Fragment | ErrorResult_SettlePaymentError_Fragment | ErrorResult_EmptyOrderLineSelectionError_Fragment | ErrorResult_ItemsAlreadyFulfilledError_Fragment | ErrorResult_InsufficientStockOnHandError_Fragment | ErrorResult_MultipleOrderError_Fragment | ErrorResult_CancelActiveOrderError_Fragment | ErrorResult_PaymentOrderMismatchError_Fragment | ErrorResult_RefundOrderStateError_Fragment | ErrorResult_NothingToRefundError_Fragment | ErrorResult_AlreadyRefundedError_Fragment | ErrorResult_QuantityTooGreatError_Fragment | ErrorResult_RefundStateTransitionError_Fragment | ErrorResult_PaymentStateTransitionError_Fragment | ErrorResult_FulfillmentStateTransitionError_Fragment | ErrorResult_ProductOptionInUseError_Fragment | ErrorResult_MissingConditionsError_Fragment | ErrorResult_NativeAuthStrategyError_Fragment | ErrorResult_InvalidCredentialsError_Fragment | ErrorResult_OrderStateTransitionError_Fragment | ErrorResult_EmailAddressConflictError_Fragment;
+export type ErrorResultFragment = ErrorResult_MimeTypeError_Fragment | ErrorResult_LanguageNotAvailableError_Fragment | ErrorResult_ChannelDefaultLanguageError_Fragment | ErrorResult_SettlePaymentError_Fragment | ErrorResult_EmptyOrderLineSelectionError_Fragment | ErrorResult_ItemsAlreadyFulfilledError_Fragment | ErrorResult_InvalidFulfillmentHandlerError_Fragment | ErrorResult_CreateFulfillmentError_Fragment | ErrorResult_InsufficientStockOnHandError_Fragment | ErrorResult_MultipleOrderError_Fragment | ErrorResult_CancelActiveOrderError_Fragment | ErrorResult_PaymentOrderMismatchError_Fragment | ErrorResult_RefundOrderStateError_Fragment | ErrorResult_NothingToRefundError_Fragment | ErrorResult_AlreadyRefundedError_Fragment | ErrorResult_QuantityTooGreatError_Fragment | ErrorResult_RefundStateTransitionError_Fragment | ErrorResult_PaymentStateTransitionError_Fragment | ErrorResult_FulfillmentStateTransitionError_Fragment | ErrorResult_ProductOptionInUseError_Fragment | ErrorResult_MissingConditionsError_Fragment | ErrorResult_NativeAuthStrategyError_Fragment | ErrorResult_InvalidCredentialsError_Fragment | ErrorResult_OrderStateTransitionError_Fragment | ErrorResult_EmailAddressConflictError_Fragment;
 
 export type ShippingMethodFragment = (
   { __typename?: 'ShippingMethod' }
-  & Pick<ShippingMethod, 'id' | 'createdAt' | 'updatedAt' | 'code' | 'name' | 'description'>
+  & Pick<ShippingMethod, 'id' | 'createdAt' | 'updatedAt' | 'code' | 'name' | 'description' | 'fulfillmentHandlerCode'>
   & { checker: (
     { __typename?: 'ConfigurableOperation' }
     & ConfigurableOperationFragment
@@ -7180,6 +7221,9 @@ export type GetShippingMethodOperationsQuery = { shippingEligibilityCheckers: Ar
   )>, shippingCalculators: Array<(
     { __typename?: 'ConfigurableOperationDefinition' }
     & ConfigurableOperationDefFragment
+  )>, fulfillmentHandlers: Array<(
+    { __typename?: 'ConfigurableOperationDefinition' }
+    & ConfigurableOperationDefFragment
   )> };
 
 export type CreateShippingMethodMutationVariables = Exact<{
@@ -8508,6 +8552,7 @@ export namespace GetShippingMethodOperations {
   export type Query = GetShippingMethodOperationsQuery;
   export type ShippingEligibilityCheckers = NonNullable<(NonNullable<GetShippingMethodOperationsQuery['shippingEligibilityCheckers']>)[number]>;
   export type ShippingCalculators = NonNullable<(NonNullable<GetShippingMethodOperationsQuery['shippingCalculators']>)[number]>;
+  export type FulfillmentHandlers = NonNullable<(NonNullable<GetShippingMethodOperationsQuery['fulfillmentHandlers']>)[number]>;
 }
 
 export namespace CreateShippingMethod {

diff --git a/packages/admin-ui/src/lib/core/src/common/introspection-result.ts b/packages/admin-ui/src/lib/core/src/common/introspection-result.ts
@@ -27,6 +27,9 @@ const result: PossibleTypesResultData = {
             'EmptyOrderLineSelectionError',
             'ItemsAlreadyFulfilledError',
             'InsufficientStockOnHandError',
+            'InvalidFulfillmentHandlerError',
+            'FulfillmentStateTransitionError',
+            'CreateFulfillmentError',
         ],
         CancelOrderResult: [
             'Order',
@@ -117,6 +120,8 @@ const result: PossibleTypesResultData = {
             'SettlePaymentError',
             'EmptyOrderLineSelectionError',
             'ItemsAlreadyFulfilledError',
+            'InvalidFulfillmentHandlerError',
+            'CreateFulfillmentError',
             'InsufficientStockOnHandError',
             'MultipleOrderError',
             'CancelActiveOrderError',

diff --git a/packages/admin-ui/src/lib/core/src/data/definitions/shipping-definitions.ts b/packages/admin-ui/src/lib/core/src/data/definitions/shipping-definitions.ts
@@ -10,6 +10,7 @@ export const SHIPPING_METHOD_FRAGMENT = gql`
         code
         name
         description
+        fulfillmentHandlerCode
         checker {
             ...ConfigurableOperation
         }
@@ -55,6 +56,9 @@ export const GET_SHIPPING_METHOD_OPERATIONS = gql`
         shippingCalculators {
             ...ConfigurableOperationDef
         }
+        fulfillmentHandlers {
+            ...ConfigurableOperationDef
+        }
     }
     ${CONFIGURABLE_OPERATION_DEF_FRAGMENT}
 `;

diff --git a/packages/admin-ui/src/lib/core/src/data/providers/shipping-method-data.service.ts b/packages/admin-ui/src/lib/core/src/data/providers/shipping-method-data.service.ts
@@ -57,7 +57,14 @@ export class ShippingMethodDataService {
 
     createShippingMethod(input: CreateShippingMethodInput) {
         const variables: CreateShippingMethod.Variables = {
-            input: pick(input, ['code', 'checker', 'calculator', 'customFields', 'translations']),
+            input: pick(input, [
+                'code',
+                'checker',
+                'calculator',
+                'fulfillmentHandler',
+                'customFields',
+                'translations',
+            ]),
         };
         return this.baseDataService.mutate<CreateShippingMethod.Mutation, CreateShippingMethod.Variables>(
             CREATE_SHIPPING_METHOD,
@@ -67,7 +74,15 @@ export class ShippingMethodDataService {
 
     updateShippingMethod(input: UpdateShippingMethodInput) {
         const variables: UpdateShippingMethod.Variables = {
-            input: pick(input, ['id', 'code', 'checker', 'calculator', 'customFields', 'translations']),
+            input: pick(input, [
+                'id',
+                'code',
+                'checker',
+                'calculator',
+                'fulfillmentHandler',
+                'customFields',
+                'translations',
+            ]),
         };
         return this.baseDataService.mutate<UpdateShippingMethod.Mutation, UpdateShippingMethod.Variables>(
             UPDATE_SHIPPING_METHOD,

diff --git a/...in-ui/src/lib/order/src/components/fulfill-order-dialog/fulfill-order-dialog.component.ts b/...in-ui/src/lib/order/src/components/fulfill-order-dialog/fulfill-order-dialog.component.ts
@@ -63,8 +63,12 @@ export class FulfillOrderDialogComponent implements Dialog<FulfillOrderInput>, O
         }));
         this.resolveWith({
             lines,
-            trackingCode: this.trackingCode,
-            method: this.method,
+            handler: {
+                code: 'foo',
+                arguments: [],
+            },
+            // trackingCode: this.trackingCode,
+            // method: this.method,
         });
     }
 

diff --git a/.../lib/settings/src/components/shipping-method-detail/shipping-method-detail.component.html b/.../lib/settings/src/components/shipping-method-detail/shipping-method-detail.component.html
@@ -61,6 +61,17 @@
         [readonly]="!('UpdateSettings' | hasPermission)"
         [label]="'common.description' | translate"
     ></vdr-rich-text-editor>
+    <vdr-form-field [label]="'settings.fulfillment-handler' | translate" for="fulfillmentHandler" class="mb2">
+        <select
+            name="fulfillmentHandler"
+            formControlName="fulfillmentHandler"
+            [vdrDisabled]="!('UpdateSettings' | hasPermission)"
+        >
+            <option *ngFor="let handler of fulfillmentHandlers" [value]="handler.code">
+                {{ handler.code }}: {{ handler.description }}
+            </option>
+        </select>
+    </vdr-form-field>
 
     <section formGroupName="customFields" *ngIf="customFields.length">
         <label>{{ 'common.custom-fields' | translate }}</label>
@@ -74,7 +85,7 @@
         </ng-container>
     </section>
 
-    <div class="clr-row">
+    <div class="clr-row mt4">
         <div class="clr-col">
             <label class="clr-control-label">{{ 'settings.shipping-eligibility-checker' | translate }}</label>
             <vdr-configurable-input

diff --git a/...rc/lib/settings/src/components/shipping-method-detail/shipping-method-detail.component.ts b/...rc/lib/settings/src/components/shipping-method-detail/shipping-method-detail.component.ts
@@ -46,6 +46,7 @@ export class ShippingMethodDetailComponent
     detailForm: FormGroup;
     checkers: ConfigurableOperationDefinition[] = [];
     calculators: ConfigurableOperationDefinition[] = [];
+    fulfillmentHandlers: ConfigurableOperationDefinition[] = [];
     selectedChecker?: ConfigurableOperation | null;
     selectedCheckerDefinition?: ConfigurableOperationDefinition;
     selectedCalculator?: ConfigurableOperation | null;
@@ -73,6 +74,7 @@ export class ShippingMethodDetailComponent
             code: ['', Validators.required],
             name: ['', Validators.required],
             description: '',
+            fulfillmentHandler: '',
             checker: {},
             calculator: {},
             customFields: this.formBuilder.group(
@@ -89,6 +91,7 @@ export class ShippingMethodDetailComponent
         ).subscribe(([data, entity]) => {
             this.checkers = data.shippingEligibilityCheckers;
             this.calculators = data.shippingCalculators;
+            this.fulfillmentHandlers = data.fulfillmentHandlers;
             this.changeDetector.markForCheck();
             this.selectedCheckerDefinition = data.shippingEligibilityCheckers.find(
                 c => c.code === (entity.checker && entity.checker.code),
@@ -295,9 +298,10 @@ export class ShippingMethodDetailComponent
         formGroup: FormGroup,
         languageCode: LanguageCode,
     ): Omit<CreateShippingMethodInput | UpdateShippingMethodInput, 'checker' | 'calculator'> {
+        const formValue = formGroup.value;
         const input = createUpdatedTranslatable({
             translatable: shippingMethod,
-            updatedFields: formGroup.value,
+            updatedFields: formValue,
             customFieldConfig: this.customFields,
             languageCode,
             defaultTranslation: {
@@ -306,7 +310,7 @@ export class ShippingMethodDetailComponent
                 description: shippingMethod.description || '',
             },
         });
-        return input;
+        return { ...input, fulfillmentHandler: formValue.fulfillmentHandler };
     }
 
     /**
@@ -333,6 +337,7 @@ export class ShippingMethodDetailComponent
             name: currentTranslation?.name ?? '',
             description: currentTranslation?.description ?? '',
             code: shippingMethod.code,
+            fulfillmentHandler: shippingMethod.fulfillmentHandlerCode,
             checker: shippingMethod.checker || {},
             calculator: shippingMethod.calculator || {},
         });

diff --git a/packages/admin-ui/src/lib/settings/src/providers/routing/shipping-method-resolver.ts b/packages/admin-ui/src/lib/settings/src/providers/routing/shipping-method-resolver.ts
@@ -22,6 +22,7 @@ export class ShippingMethodResolver extends BaseEntityResolver<ShippingMethod.Fr
                 code: '',
                 name: '',
                 description: '',
+                fulfillmentHandlerCode: undefined as any,
                 checker: undefined as any,
                 calculator: undefined as any,
                 translations: [],