@robinpath/bigcommerce - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

README.md

+# @robinpath/bigcommerce
+
+> BigCommerce module for RobinPath.
+
+![Category](https://img.shields.io/badge/category-E-Commerce-blue) ![Functions](https://img.shields.io/badge/functions-21-green) ![Auth](https://img.shields.io/badge/auth-API%20Key-orange) ![License](https://img.shields.io/badge/license-MIT-brightgreen)
+
+## Why use this module?
+
+The `bigcommerce` module lets you:
+
+- listProducts
+- getProduct
+- createProduct
+- updateProduct
+- deleteProduct
+
+All functions are callable directly from RobinPath scripts with a simple, consistent API.
+
+## Installation
+
+```bash
+npm install @robinpath/bigcommerce
+```
+
+## Quick Start
+
+**1. Set up credentials**
+
+```robinpath
+bigcommerce.setCredentials "your-credentials"
+```
+
+**2. listProducts**
+
+```robinpath
+bigcommerce.listProducts
+```
+
+## Available Functions
+
+| Function | Description |
+|----------|-------------|
+| `bigcommerce.setCredentials` | Configure bigcommerce credentials. |
+| `bigcommerce.listProducts` | listProducts |
+| `bigcommerce.getProduct` | getProduct |
+| `bigcommerce.createProduct` | createProduct |
+| `bigcommerce.updateProduct` | updateProduct |
+| `bigcommerce.deleteProduct` | deleteProduct |
+| `bigcommerce.listOrders` | listOrders |
+| `bigcommerce.getOrder` | getOrder |
+| `bigcommerce.updateOrder` | updateOrder |
+| `bigcommerce.listCustomers` | listCustomers |
+| `bigcommerce.getCustomer` | getCustomer |
+| `bigcommerce.createCustomer` | createCustomer |
+| `bigcommerce.updateCustomer` | updateCustomer |
+| `bigcommerce.listCategories` | listCategories |
+| `bigcommerce.createCategory` | createCategory |
+| `bigcommerce.listBrands` | listBrands |
+| `bigcommerce.createBrand` | createBrand |
+| `bigcommerce.getOrderProducts` | getOrderProducts |
+| `bigcommerce.getStoreInfo` | getStoreInfo |
+| `bigcommerce.listChannels` | listChannels |
+| `bigcommerce.getOrderShipments` | getOrderShipments |
+
+## Examples
+
+### listProducts
+
+```robinpath
+bigcommerce.listProducts
+```
+
+### getProduct
+
+```robinpath
+bigcommerce.getProduct
+```
+
+### createProduct
+
+```robinpath
+bigcommerce.createProduct
+```
+
+## Integration with RobinPath
+
+```typescript
+import { RobinPath } from "@wiredwp/robinpath";
+import Module from "@robinpath/bigcommerce";
+
+const rp = new RobinPath();
+rp.registerModule(Module.name, Module.functions);
+rp.registerModuleMeta(Module.name, Module.functionMetadata);
+
+const result = await rp.executeScript(`
+  bigcommerce.setCredentials "your-credentials"
+  bigcommerce.listProducts
+`);
+```
+
+## Full API Reference
+
+See [MODULE.md](./MODULE.md) for complete documentation including all parameters, return types, error handling, and advanced examples.
+
+## Related Modules
+
+- [`@robinpath/shopify`](../shopify) — Shopify module for complementary functionality
+- [`@robinpath/woocommerce`](../woocommerce) — WooCommerce module for complementary functionality
+- [`@robinpath/square`](../square) — Square module for complementary functionality
+- [`@robinpath/json`](../json) — JSON module for complementary functionality
+
+## License
+
+MIT

package.json

 {
   "name": "@robinpath/bigcommerce",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
@@ -5,0 +5,0 @@ "access": "public"

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

34358

9.61%

Number of package files

10

11.11%

Number of medium quality alerts

0

-100%

Number of lines in readme file

115

Infinity%

Worsened metrics

Number of medium supply chain risk alerts

2

100%

No dependency changes