npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@makaira/storefront-shop-adapter-oxid

v1.3.0

Published

Contains the makaira oxid shop adapter to connect your storefront with your oxid shop

Downloads

8

Readme

@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