Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@justeat/f-checkout

Package Overview
Dependencies
Maintainers
53
Versions
175
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@justeat/f-checkout

Fozzie Checkout – Fozzie Checkout Component

  • 2.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
53
Weekly downloads
 
Created
Source

f-checkout

Fozzie Bear

Fozzie Checkout Component


npm version CircleCI Coverage Status Known Vulnerabilities

Usage

  1. Install the module using NPM or Yarn:

    yarn add @justeat/f-checkout
    
    npm install @justeat/f-checkout
    
  2. Import the component and its module, ensuring the latter is registered in the Vuex store upon creation.

    You can import it in your Vue SFC like this (please note that styles have to be imported separately):

    import { VueCheckout, CheckoutModule } from '@justeat/f-checkout';
    import '@justeat/f-checkout/dist/f-checkout.css';
    
    export default {
        components: {
            VueCheckout
        },
    
        created () {
            if (!this.$store.hasModule('checkout')) {
                this.$store.registerModule('checkout', CheckoutModule);
            }
        },
    }
    

    If you are using Webpack, you can import the component dynamically to separate the vue-checkout bundle from the main bundle.client.js:

    import '@justeat/f-checkout/dist/f-checkout.css';
    
    export default {
        components: {
            ...
            VueCheckout: () => import(/* webpackChunkName: "vue-checkout" */ '@justeat/f-checkout')
        }
    }
    
    

Configuration

Props

f-checkout has a number of props that allow you to customise its functionality.

The props that can be defined are as follows:

PropTypeDefaultDescription
updateCheckoutUrlString-URL for the API called to update the Checkout Data
getCheckoutUrlString-URL for the API called to load the Checkout Data.

The data returned from this API contains the serviceType, which determines if the Checkout component is created for Collection or Delivery when the user is authenticated.
checkoutAvailableFulfilmentUrlString-URL for the API called to load the Available Fulfilment data.
createGuestUrlString-URL for the API called to load the Create a Guest User.
getBasketUrlString-URL for the API called to get Basket Details.

The data returned from this API contains the serviceType, which determines if the Checkout component is created for Collection or Delivery when the user is not authenticated.
placeOrderUrlString-URL for the API called to place the order.

The data returned from this API contains the orderId, which is needed to redirect the user to the payment page.
getGeoLocationUrlString-URL for the API that can return geo location information (Latitude and Longitude) for a given address.
The tenant must be provided as the last segment of the URL and all calls must be authenticated.
checkoutTimeoutNumber10000Timeout for the different API calls in the component.
authTokenString''Authorisation token used when submitting the checkout form.
otacToAuthExchangerFunctionthrow new Error('otacToAuthExchanger is not implemented');Function to exchange OTAC to JWT auth token
loginUrlString-URL to navigate to if the user wishes to change account.
paymentPageUrlPrefixString-URL prefix to navigate to after the order has been successfully placed, so the user can pay. The orderId will be appended to this URL to form the full URL.
applicationNameString-The name of the application using this component.

Events

EventDescription
checkout-payment-successEmitted when checkout form is successfully submitted.
checkout-payment-failureEmitted when checkout form fails when submitted.
checkout-get-successEmitted when checkout data is successfully loaded.
checkout-get-failureEmitted when checkout data fails to load.
checkout-available-fulfilment-get-successEmitted when available fulfilment times are successfully loaded.
checkout-available-fulfilment-get-failureEmitted when available fulfilment times fail to load.
checkout-visit-login-pageEmitted when user clicks the Not you? link
checkout-basket-get-successEmitted when basket data is successfully loaded.
checkout-basket-get-failureEmitted when basket data is not successfully loaded.
checkout-setup-guest-successEmitted when guest user is created successfully.
checkout-setup-guest-failureEmitted when guest user is not created successfully.
checkout-validation-errorEmitted validation error occurs.
checkout-address-get-successEmitted when address is returned successfully.
checkout-address-get-failureEmitted when address is not returned successfully.
checkout-error-dialog-button-clickEmitted when the error dialog ok is clicked.
checkout-dialog-close-button-clickEmitted when the error dialog close is clicked.
checkout-place-order-successEmitted when order is successfully placed.
checkout-place-order-failureEmitted when order is not successfully placed.
checkout-update-successEmitted when checkout is successfully updated.
checkout-update-failureEmitted when checkout is not successfully updated.

You can add event listeners for these like so

<template>
  <vue-checkout
    @checkoutPaymentSuccess="onPaymentSuccess"
    @checkoutPaymentFailure="onPaymentFailure"
    @checkoutGetSuccess="onGetCheckoutSuccess"
    @checkoutGetFailure="onGetCheckoutFailure"
    @checkoutGetPaymentSuccess="onGetPaymentSuccess"
    @checkoutGetPaymentFailure="onGetPaymentFailure"
    @checkoutGetBasketSuccess="onGetBasketSuccess"
    @checkoutGetBasketFailure="onGetBasketFailure"
    @checkoutSetupGuestSuccess="onSetupGuestSuccess"
    @checkoutSetupGuestFailure="onSetupGuestFailure"
    @checkoutValidationError="onValidationError">
  </vue-checkout>
</template>

<script>
export default {
  methods: {
    onPaymentSuccess () {
      // Do stuff here
    },

    onPaymentFailure () {
      // Do stuff here
    },

    onGetCheckoutSuccess () {
      // Do stuff here
    },

    onGetCheckoutFailure () {
      // Do stuff here
    },


    onGetPaymentSuccess () {
      // Do stuff here
    },

    onGetPaymentFailure () {
      // Do stuff here
    },

    onGetBasketSuccess () {
      // Do stuff here
    },

    onGetBasketFailure () {
      // Do stuff here
    },

  }
}
</script>

Development

It is recommended to run the following commands at the root of the monorepo in order to install dependencies and allow you to view components in isolation via Storybook.

# cd ./fozzie-components
yarn install

## Testing
Unit / Integration / Contract

```bash
# Run Unit / Integration / Contract tests for all components
cd ./fozzie-components
yarn test

OR

# Run Unit / Integration / Contract tests for f-checkout
cd ./fozzie-components/packages/f-checkout
yarn test

Component Tests

# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome

OR

# Run Component tests for f-checkout
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/f-checkout
yarn test-component:chrome

Documentation to be completed once module is in stable state.

Keywords

FAQs

Package last updated on 06 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc