@wbsuite/react-hooks 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,62 @@
+## Installing wbsuite react hooks library
+1. Install dependency in your proyect by running `npm i @wbsuite/react-hooks`
+
+## How to use
+1. Set up wbsuite by running the `useWBSuite` hook with the api key you were given.
+
+```
+function App() {
+  useWBSuite({ apiKey: '<your-api-key>' });
+  return <></>
+}
+```
+
+2. You're ready to start using the hooks you need. This library version contains:
+  - useStores -- lists available stores for your team
+  - useProducts -- lists products available for your team
+  - useCategories -- lists categories available for your team
+  - useRenting -- renting utils
+  - useDocuments -- document / images utils
+  - useContact -- create leads for your campaigns, use this for contacts or whatever you need.
+
+### useCategories
+This hook is used to list, get or create categories. In order to use it consider:
+
+```
+  const { list: listCategories } = useCategories();
+
+  useEffect(() => {
+    listCategories().then(categoryList => {
+      // Do what you need with the categoryList
+    });
+  }, []);
+```
+
+### useProducts
+This hook is used to list, get or create products. In order to use it consider:
+
+```
+  const { list: listProducts } = useProducts();
+
+  useEffect(() => {
+    /** filters needs to be an object with any valid property of the product schema.
+    * for example to get the products from a category you need to pass in an object like:
+    * { categories: <categoryId>[] }
+    *
+    * { categories: ['some-category-id', 'other-category-id'] }
+    *
+    * The categoryId can be retrieved from the useCategories hook explained above.
+    **/
+    listProducts(filters ?? {}).then(filteredProductList => {
+      // Do what you need with the filteredProductList
+    });
+  }, []);
+```
+
+## Permissions
+Even if the hooks are available in the library the `apiKey` limits the permissions you have
+access to.
+
+Which means, that you won't be able to use all of our features unless you were given access to.
+
+If, you find yourself in need of using a non-accessible util, please reach out to the provider.

package/package.json

@@ -1 +1,28 @@
-{"name":"@wbsuite/react-hooks","version":"1.0.0","description":"","main":"cjs/index.js","module":"esm/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","lint":"npx eslint src/**","build":"npm run build:esm && npm run build:cjs","build:esm":"tsc","build:cjs":"tsc --module commonjs --outDir dist/react-hooks/cjs","pre-publish":"npm run lint && rm -rf dist && npm run build && cp package*.json dist/react-hooks"},"author":"faluma@webbuilders.com.ar","license":"ISC","devDependencies":{"@wb/types":"^2.0.0","eslint":"^8.57.0","typescript":"^5.3.3","typescript-eslint":"^7.0.2","@eslint/js":"^8.57.0"},"dependencies":{"axios":"^1.6.7"}}
+{
+  "name": "@wbsuite/react-hooks",
+  "version": "1.0.2",
+  "description": "",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "npx eslint src/**",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc",
+    "build:cjs": "tsc --module commonjs --outDir dist/react-hooks/cjs",
+    "pre-publish": "npm run lint && rm -rf dist && npm run build && cp package*.json dist/react-hooks && cp README.md dist/react-hooks",
+		"publish-to-npm": "cd dist/react-hooks && npm publish --access public --registry=https://registry.npmjs.org/"
+  },
+  "author": "faluma@webbuilders.com.ar",
+  "license": "ISC",
+  "devDependencies": {
+    "@wb/types": "^2.0.0",
+    "eslint": "^8.57.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^7.0.2",
+    "@eslint/js": "^8.57.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.7"
+  }
+}