Skip to content

Latest commit

 

History

History
152 lines (99 loc) · 3.42 KB

Readme.md

File metadata and controls

152 lines (99 loc) · 3.42 KB

@makaira/storefront-shop-adapter-oxid

This shop adapter can be used to connect your oxid shop with your storefront. This adapter is developed based on the oxid-connect plugin.

Installation

yarn install @makaira/storefront-types @makaira/storefront-shop-adapter-oxid

or

npm install @makaira/storefront-types @makaira/storefront-shop-adapter-oxid

Adding to your project

Basic usage

import { StorefrontShopAdapterOxid } from '@makaira/storefront-shop-adapter-oxid'

const client = new StorefrontShopAdapterOxid({
  url: '<OXID-API-BASE-URL>',
})

Usage with @makaira/storefront-react

import { StorefrontShopAdapterOxid } from '@makaira/storefront-shop-adapter-oxid'
import { ShopProvider } from '@makaira/storefront-react'

const client = new StorefrontShopAdapterOxid({
  url: '<OXID-API-BASE-URL>',
})

function Index() {
  return (
    <ShopProvider client={shopClient}>
      <App />
    </ShopProvider>
  )
}

In addition if you are using typescript in your project and want to get the correct autosuggestion you have to create a new declaration file (e.g index.d.ts) with the following content:

import '@makaira/storefront-react'
import { StorefrontShopAdapterOxid } from '@makaira/storefront-shop-adapter-oxid'

declare module '@makaira/storefront-react' {
  interface StorefrontReactCustomClient {
    client: StorefrontShopAdapterOxid
  }
}

Additional constructor arguments

Argument Required/Optional Description Type
url required The base api url to made requests again. string

Feature map

Feature Available
cart
- addItem ✅
- getCart ✅
- removeItem ✅
- updateItem ✅
review
- getReviews ✅
- createReview ✅
user
- login ✅
- logout ✅
- signup ❌
- getUser ✅
- forgotPassword ❌
wishlist
- getWishlist ❌
- addItem ❌
- removeItem ❌

Additional input properties

Cart

getCart

No additional properties

addItem

No additional properties

removeItem

No additional properties

updateItem

No additional properties

Review

getReviews

No additional properties

createReview

No additional properties

User

getUser

No additional properties

login

Property Required/Optional Description Type
rememberLogin required If the login should be remembered or should expire automatically after browser closing. boolean

logout

No additional properties

signup

Not implemented

forgotPassword

Not implemented

Wishlist

getWishlist

Not implemented

addItem

Not implemented

removeItem

Not implemented