@leafwell/client-store

Leafwell Provider Client

A simple document for Leafwell Provider client's lib for any of these enviroments: Node.js and compatible with React and React Native. For better understading about the methods and arguments, please make ensure you have typescript installed and configured on your project.

Installation

Using npm:

$ npm install @leafwell/client-store

Using yarn:

$ yarn add @leafwell/client-store

Example

import Client from "@leafwell/client-store";

type ClientHeaders = {
  hasuraAdmin?: string;
  authorizationBearer?: string;
};

(async function main() {
  /**
   * Using hasuraAdmin will overwrite authorization bearer use mode and, therefore, you will be granted with admin permissions
   * */
  const options: ClientHeaders = {
    hasuraAdmin: "",
    authorizationBearer: "",
  };

  Client.initialize("url", options);

  const stores = await Client.api.getStores();

  console.log(stores);
})();

Usage

Authenticate

You need to start by authentication. Use the initialize method to setup and prepare your api client:

/**
 * Using hasuraAdmin will overwrite authorization bearer use mode and, therefore, you will be granted with admin permissions
 * */
const options: ClientHeaders = {
  hasuraAdmin: "",
  authorizationBearer: "",
};

Client.initialize("url", options);

Methods/properties available

Client.initialize();
Client.api;

Methods available in api property:

Products

api.getProducts();

api.getProduct();

api.getEffects();

api.getProductVariants();

Companies

api.getCompanies();

api.getCompany();

Promotions

api.getPromotions();

api.getPromotionsByStoreId();

api.getPromotion();

Stores

api.getStores();

api.getStore();

Checkout

api.getCheckout();

api.createCheckout();

api.addItemToCheckout();

api.removeItemToCheckout();

api.updateItemQuantityFromCheckout();

api.updateCheckout();

Brand

api.getBrand();

api.getBrands();

Category

api.getCategories();

Category

api.getCategories();

Order

api.getOrders();

api.saveOrder();