@simpoobusiness/sdk 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/package.json +14 -6
package/README.md
CHANGED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @simpoobusiness/sdk
|
|
2
|
+
|
|
3
|
+
A React-based SDK for embedding **Simpoo Business components** (like Inventory Table) into your application.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Installation
|
|
8
|
+
|
|
9
|
+
Install via npm or yarn:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @simpoobusiness/sdk
|
|
13
|
+
# OR
|
|
14
|
+
yarn add @simpoobusiness/sdk
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## ✅ Features
|
|
18
|
+
|
|
19
|
+
- 📊 Inventory Table Component – Display real-time inventory.
|
|
20
|
+
|
|
21
|
+
- 🔐 Secure API Calls – Uses your Simpoo API key.
|
|
22
|
+
|
|
23
|
+
- 🎨 Styled with Tailwind & Responsive UI.
|
|
24
|
+
|
|
25
|
+
- ⚡ Lightweight & Easy Integration.
|
|
26
|
+
|
|
27
|
+
## 📦 Usage
|
|
28
|
+
|
|
29
|
+
Import and use the SDK components in your React application:
|
|
30
|
+
|
|
31
|
+
Wrap your app with the **SimpooProvider** and pass your API key:
|
|
32
|
+
|
|
33
|
+
```jsx
|
|
34
|
+
import { SimpooProvider, InventoryTable } from "@simpoobusiness/sdk";
|
|
35
|
+
|
|
36
|
+
export default function App() {
|
|
37
|
+
return (
|
|
38
|
+
<SimpooProvider apiKey="YOUR_API_KEY">
|
|
39
|
+
<div style={{ padding: "20px" }}>
|
|
40
|
+
<h1>My Inventory</h1>
|
|
41
|
+
<InventoryTable />
|
|
42
|
+
</div>
|
|
43
|
+
</SimpooProvider>
|
|
44
|
+
);
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
> **Note:** Replace `YOUR_API_KEY` with your actual Simpoo Business API key.
|
|
49
|
+
|
|
50
|
+
## 🛠️ Available Components
|
|
51
|
+
|
|
52
|
+
- `InventoryTable`: Displays your business inventory.
|
|
53
|
+
- More components coming soon!
|
|
54
|
+
|
|
55
|
+
## ⚙️ Props
|
|
56
|
+
|
|
57
|
+
Each component may accept specific props. For example, `InventoryTable`:
|
|
58
|
+
|
|
59
|
+
| Prop | Type | Description |
|
|
60
|
+
| ------ | ------ | ---------------------------- |
|
|
61
|
+
| apiKey | string | Your Simpoo Business API key |
|
|
62
|
+
|
|
63
|
+
## 📖 Documentation
|
|
64
|
+
|
|
65
|
+
See the [official docs](https://simpoobusiness.com/docs/sdk) for more details and advanced usage.
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simpoobusiness/sdk",
|
|
3
3
|
"publishConfig": {
|
|
4
|
-
|
|
5
|
-
},
|
|
6
|
-
"version": "1.0.
|
|
4
|
+
"access": "public"
|
|
5
|
+
},
|
|
6
|
+
"version": "1.0.1",
|
|
7
7
|
"main": "dist/cjs/index.js",
|
|
8
8
|
"module": "dist/esm/index.js",
|
|
9
9
|
"types": "dist/index.d.ts",
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
"dist"
|
|
12
12
|
],
|
|
13
13
|
"scripts": {
|
|
14
|
+
"docs": "typedoc --out docs src",
|
|
14
15
|
"clean": "rimraf dist",
|
|
15
16
|
"build": "npm run clean && npm run build:css && npm run build:types && rollup -c --bundleConfigAsCjs",
|
|
16
17
|
"build:types": "tsc -p tsconfig.build.json",
|
|
@@ -20,10 +21,15 @@
|
|
|
20
21
|
"yalc:publish": "yalc publish",
|
|
21
22
|
"yalc:watch": "yalc push --watch",
|
|
22
23
|
"postbuild": "yalc push",
|
|
23
|
-
|
|
24
|
-
|
|
24
|
+
"prepare": "npm run build",
|
|
25
|
+
"publish:npm": "npm run build && npm publish --access public"
|
|
25
26
|
},
|
|
26
|
-
"keywords": [
|
|
27
|
+
"keywords": [
|
|
28
|
+
"sdk",
|
|
29
|
+
"react",
|
|
30
|
+
"inventory",
|
|
31
|
+
"simpooBusiness"
|
|
32
|
+
],
|
|
27
33
|
"author": "",
|
|
28
34
|
"license": "ISC",
|
|
29
35
|
"description": "",
|
|
@@ -48,6 +54,8 @@
|
|
|
48
54
|
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
49
55
|
"rollup-plugin-postcss": "^4.0.2",
|
|
50
56
|
"tailwindcss": "^4.1.11",
|
|
57
|
+
"typedoc": "^0.28.7",
|
|
58
|
+
"typedoc-plugin-markdown": "^4.7.1",
|
|
51
59
|
"typescript": "^5.8.3"
|
|
52
60
|
},
|
|
53
61
|
"dependencies": {
|