@elizaos/plugin-shopify-ui 2.0.11-beta.7
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/LICENSE +21 -0
- package/README.md +57 -0
- package/package.json +74 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Shaw Walters and elizaOS Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @elizaos/plugin-shopify-ui
|
|
2
|
+
|
|
3
|
+
Shopify store management for elizaOS agents. Adds REST API routes and a React dashboard UI covering orders, products, inventory, and customers.
|
|
4
|
+
|
|
5
|
+
## What it does
|
|
6
|
+
|
|
7
|
+
- Registers seven HTTP routes under `/api/shopify/*` that proxy to the Shopify Admin GraphQL API.
|
|
8
|
+
- Provides a tabbed React dashboard (standard + XR view) and a terminal-compatible TUI view.
|
|
9
|
+
- Displays store overview, recent orders, low-inventory alerts, product catalog, customer list, and per-location inventory levels.
|
|
10
|
+
- Supports creating new draft products and adjusting inventory quantities directly from the UI.
|
|
11
|
+
|
|
12
|
+
## Capabilities / routes
|
|
13
|
+
|
|
14
|
+
| Endpoint | Description |
|
|
15
|
+
|----------|-------------|
|
|
16
|
+
| `GET /api/shopify/status` | Check connection; returns shop name, domain, plan, currency |
|
|
17
|
+
| `GET /api/shopify/products` | List products with pagination and search |
|
|
18
|
+
| `POST /api/shopify/products` | Create a draft product |
|
|
19
|
+
| `GET /api/shopify/orders` | List orders filtered by financial status |
|
|
20
|
+
| `GET /api/shopify/inventory` | List inventory levels across all locations |
|
|
21
|
+
| `POST /api/shopify/inventory/:itemId/adjust` | Adjust available quantity for an inventory item |
|
|
22
|
+
| `GET /api/shopify/customers` | List customers with search |
|
|
23
|
+
|
|
24
|
+
## Required environment variables
|
|
25
|
+
|
|
26
|
+
| Variable | Description |
|
|
27
|
+
|----------|-------------|
|
|
28
|
+
| `SHOPIFY_STORE_DOMAIN` | Your store domain, e.g. `mystore.myshopify.com` |
|
|
29
|
+
| `SHOPIFY_ACCESS_TOKEN` | Shopify Admin API access token |
|
|
30
|
+
|
|
31
|
+
Without these, the status endpoint returns `{connected: false}` and all data routes return 404.
|
|
32
|
+
|
|
33
|
+
## Required Shopify API scopes
|
|
34
|
+
|
|
35
|
+
`read_products`, `write_products`, `read_orders`, `read_inventory`, `write_inventory`, `read_customers`
|
|
36
|
+
|
|
37
|
+
## How to enable
|
|
38
|
+
|
|
39
|
+
Add the plugin to your elizaOS agent configuration:
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
import { shopifyPlugin } from "@elizaos/plugin-shopify-ui/plugin";
|
|
43
|
+
|
|
44
|
+
// Pass to your agent runtime plugin list
|
|
45
|
+
const agent = new AgentRuntime({
|
|
46
|
+
plugins: [shopifyPlugin],
|
|
47
|
+
// ...
|
|
48
|
+
});
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The dashboard view appears at path `/shopify` in the elizaOS UI. The TUI view is available at `/shopify/tui` for terminal-based agent surfaces.
|
|
52
|
+
|
|
53
|
+
## Notes
|
|
54
|
+
|
|
55
|
+
- The inventory endpoint fetches up to 50 products × 10 variants × 10 locations per query. Large catalogs are truncated at these limits.
|
|
56
|
+
- The Shopify GraphQL API version is `2025-04`.
|
|
57
|
+
- Product pagination uses cursor-chain traversal; prefer the search parameter (`?q=`) for large catalogs to avoid deep page walks.
|
package/package.json
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@elizaos/plugin-shopify-ui",
|
|
3
|
+
"version": "2.0.11-beta.7",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"exports": {
|
|
7
|
+
".": {
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"eliza-source": {
|
|
10
|
+
"types": "./src/index.ts",
|
|
11
|
+
"import": "./src/index.ts",
|
|
12
|
+
"default": "./src/index.ts"
|
|
13
|
+
},
|
|
14
|
+
"import": "./dist/index.js",
|
|
15
|
+
"default": "./dist/index.js"
|
|
16
|
+
},
|
|
17
|
+
"./plugin": {
|
|
18
|
+
"types": "./dist/plugin.d.ts",
|
|
19
|
+
"import": "./dist/plugin.js",
|
|
20
|
+
"default": "./dist/plugin.js"
|
|
21
|
+
},
|
|
22
|
+
"./*.css": "./dist/*.css",
|
|
23
|
+
"./*": {
|
|
24
|
+
"types": "./dist/*.d.ts",
|
|
25
|
+
"eliza-source": {
|
|
26
|
+
"types": "./src/*.ts",
|
|
27
|
+
"import": "./src/*.ts",
|
|
28
|
+
"default": "./src/*.ts"
|
|
29
|
+
},
|
|
30
|
+
"import": "./dist/*.js",
|
|
31
|
+
"default": "./dist/*.js"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"@elizaos/app-core": "2.0.11-beta.7",
|
|
36
|
+
"@elizaos/core": "2.0.11-beta.7",
|
|
37
|
+
"@elizaos/ui": "2.0.11-beta.7",
|
|
38
|
+
"lucide-react": "^1.0.0",
|
|
39
|
+
"react": "^19.0.0"
|
|
40
|
+
},
|
|
41
|
+
"elizaos": {
|
|
42
|
+
"app": {
|
|
43
|
+
"heroImage": "assets/hero.png"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"publishConfig": {
|
|
47
|
+
"access": "public"
|
|
48
|
+
},
|
|
49
|
+
"types": "./dist/index.d.ts",
|
|
50
|
+
"scripts": {
|
|
51
|
+
"build": "bun run build:js && bun run build:views && bun run build:types",
|
|
52
|
+
"clean": "rm -rf dist",
|
|
53
|
+
"test": "vitest run --config vitest.config.ts",
|
|
54
|
+
"build:js": "tsup --config ../tsup.plugin-packages.shared.ts",
|
|
55
|
+
"build:views": "bunx --bun vite build --config vite.config.views.ts",
|
|
56
|
+
"build:types": "tsc --noCheck -p tsconfig.build.json",
|
|
57
|
+
"test:e2e:manual": "vitest run --config ../../vitest.config.ts test/*.real.e2e.test.ts"
|
|
58
|
+
},
|
|
59
|
+
"files": [
|
|
60
|
+
"dist"
|
|
61
|
+
],
|
|
62
|
+
"devDependencies": {
|
|
63
|
+
"@testing-library/react": "^16.3.2",
|
|
64
|
+
"@types/react": "^19.0.0",
|
|
65
|
+
"@types/react-dom": "^19.0.0",
|
|
66
|
+
"jsdom": "^29.0.0",
|
|
67
|
+
"react": "^19.0.0",
|
|
68
|
+
"react-dom": "^19.0.0",
|
|
69
|
+
"tsup": "^8.5.1",
|
|
70
|
+
"vite": "^8.0.0",
|
|
71
|
+
"vitest": "^4.1.5"
|
|
72
|
+
},
|
|
73
|
+
"gitHead": "cdbc876f793d96073d7eb0d09715a031ce0cd32e"
|
|
74
|
+
}
|