@ljmarquezge2y/spartacus

Worldpay Connector for the SAP Spartacus Storefront

The Worldpay Connector for SAP Spartacus Storefront is an Angular Library that provides the components to integrate WorldPay payment solutions with the SAP Commerce Cloud Spartacus storefront.

About Worldpay from FIS

Worldpay from FIS is one of the world's leading global eCommerce and payment technology companies. FIS is a leading provider of technology solutions for merchants, banks and capital markets firms globally.

About Spartacus

Spartacus is a lean, Angular-based JavaScript storefront for SAP Commerce Cloud that communicates exclusively through the Commerce REST API. Spartacus documentation: https://sap.github.io/spartacus-docs/. Release information: https://sap.github.io/spartacus-docs/release-information/.

Requirements

• SAP Commerce Cloud instance, Release 2005 recommended (Spartacus B2B features require SAP Commerce Cloud 2005). Works with 1905 with reduced functionality
• Angular CLI: v9.1 or later, < v10.0
• node.js: 10.14.1 or later, < 13.0. The most recent 12.x version is recommended
• yarn: v1.15 or later

Compatibility

The Connector is compatible with the Spartacus Release 2.1.2

Installation & Usage

Development

Run the command ./install.sh to do a clean install and run the example-storefront

Installing Spartacus

• Install worldpay-spartacus to your Spartacus project - final name pending

  npm install @worldpay2020/worldpay-spartacus

Configuring Spartacus

Perform the following in your Spartacus storefront's app.module.ts file.

• Import the worldpay-spartacus modules and components

import { 
   WorldpayPaymentComponentModule,
   WorldpayPlaceOrderComponentModule,
   WorldpayStoreModule,
   OccWorldpayModule,
   WorldpayPaymentComponent,
   WorldpayPlaceOrderComponent,
   WorldpayDdcIframeModule,
   WorldpayDdcIframeRoutingModule,
   Worldpay3dsChallengeIframeModule,
   Worldpay3dsChallengeIframeRoutingModule,
   worldpayTranslations
} from '@worldpay2020/worldpay-spartacus';

@NgModule({
  imports: [
    WorldpayPaymentComponentModule,
    WorldpayPlaceOrderComponentModule,
    WorldpayStoreModule,
    WorldpayDdcIframeModule,
    WorldpayDdcIframeRoutingModule,
    Worldpay3dsChallengeIframeModule,
    Worldpay3dsChallengeIframeRoutingModule,
    OccWorldpayModule,
    ...
  ],
  ...
})

• Override the following CMS components in the B2cStorefrontModule

@NgModule({
  imports: [
    ...,
    B2cStorefrontModule.withConfig({
      cmsComponents: {
        CheckoutPaymentDetails: {
          component: WorldpayPaymentComponent
        },
        CheckoutPlaceOrder: {
          component: WorldpayPlaceOrderComponent
        }
      },
      ...
    }),
    ...
  ]
})

• Add additional translations in the ConfigModule

@NgModule({
  imports: [
    ...,
    ConfigModule.withConfig({
      i18n: { resources: worldpayTranslations },
      ...
    }),
    ...
  ]
})

License

Copyright (c) 2020 Worldpay Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.