@elizaos/plugin-shopify 2.0.0-beta.1 → 2.0.3-beta.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,91 @@
+# @elizaos/plugin-shopify
+
+Shopify Admin API plugin for elizaOS. Gives an Eliza agent the ability to manage products, orders, inventory, and customers on a Shopify store through conversational commands.
+
+## What it does
+
+When this plugin is active, an Eliza agent can:
+
+- **Search** — read-only cross-entity search across products, orders, and customers.
+- **Manage products** — list products (with optional query), create new products (DRAFT or ACTIVE), update title / description / status.
+- **Manage inventory** — check stock levels per location, adjust inventory quantities, list store locations.
+- **Manage orders** — list orders (with optional filter), get a single order by number, fulfill open orders.
+- **Manage customers** — list or search customers, view customer detail.
+
+Write operations (create product, update product, adjust inventory, fulfill order) ask the user for explicit confirmation before executing.
+
+## Installation
+
+Add the plugin to your agent's character file:
+
+```json
+{
+  "plugins": ["@elizaos/plugin-shopify"]
+}
+```
+
+The plugin self-enables when `SHOPIFY_ACCESS_TOKEN` or `SHOPIFY_ACCOUNTS` is set in the agent's environment. No explicit opt-in is required when either variable is present.
+
+## Configuration
+
+### Minimum required
+
+| Variable | Description |
+|---|---|
+| `SHOPIFY_STORE_DOMAIN` | Your store domain, e.g. `mystore.myshopify.com` |
+| `SHOPIFY_ACCESS_TOKEN` | Shopify Admin API access token from a private or custom app |
+
+### Shopify API scopes needed
+
+Your access token must have at minimum:
+
+```
+read_products, write_products, read_orders, write_orders,
+read_customers, read_inventory, write_inventory, read_locations
+```
+
+### Multi-store support
+
+To connect more than one store, set `SHOPIFY_ACCOUNTS` to a JSON array of account records:
+
+```json
+[
+  { "accountId": "store-a", "storeDomain": "store-a.myshopify.com", "accessToken": "shpat_..." },
+  { "accountId": "store-b", "storeDomain": "store-b.myshopify.com", "accessToken": "shpat_..." }
+]
+```
+
+Set `SHOPIFY_DEFAULT_ACCOUNT_ID` to the `accountId` that should be used when none is specified in a request. Accounts can also be declared under `character.settings.shopify.accounts` in the character file.
+
+### OAuth flow (optional)
+
+If you want users to connect stores through an OAuth flow rather than a static access token, set:
+
+| Variable | Description |
+|---|---|
+| `SHOPIFY_OAUTH_CLIENT_ID` | Client ID from your Shopify app |
+| `SHOPIFY_OAUTH_CLIENT_SECRET` | Client secret from your Shopify app |
+| `SHOPIFY_OAUTH_REDIRECT_URI` | Redirect URI registered in your Shopify app settings |
+
+## Usage examples
+
+```
+Show me my Shopify orders from this week
+Search my store for "blue hat"
+List all active products
+Create a new product: red t-shirt, $25, vendor Acme
+Adjust inventory for blue hat by -3 units
+Fulfill order #1042
+Find customer jane@example.com
+```
+
+The agent infers the operation from natural language. You can also be explicit:
+
+```
+Shopify action=products action=list
+Shopify action=inventory action=check productQuery="blue hat"
+```
+
+## Context requirements
+
+The `SHOPIFY` action is available in agent contexts: `payments`, `connectors`, `automation`, `knowledge`. The store context provider activates in `connectors` and `finance` contexts. Ensure your agent character has at least one of these contexts enabled.

package/package.json

@@ -1,31 +1,48 @@
 {
   "name": "@elizaos/plugin-shopify",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.3-beta.3",
   "description": "Shopify Admin API plugin for elizaOS agents -- manage products, orders, inventory, and customers.",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
+      "eliza-source": {
+        "types": "./src/index.ts",
+        "import": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
       "import": "./dist/index.js"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "eliza-source": {
+        "types": "./src/*.ts",
+        "import": "./src/*.ts",
+        "default": "./src/*.ts"
+      },
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
+    "build": "tsup --config tsup.config.ts",
+    "dev": "tsup --config tsup.config.ts --watch",
     "test": "vitest run",
     "test:e2e": "node ../../packages/app-core/scripts/run-local-plugin-live-smoke.mjs",
     "test:live": "bun run test:e2e"
   },
   "dependencies": {
-    "@elizaos/core": "2.0.0-beta.1"
+    "@elizaos/core": "2.0.3-beta.3"
   },
   "devDependencies": {
-    "tsdown": "^0.21.10",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
     "vitest": "^4.0.0"
   },
   "agentConfig": {
@@ -47,5 +64,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "f54b0f4eaed317d59fa7dbcdce20f4cdb0734420"
 }

package/dist/index.d.ts

@@ -1,213 +0,0 @@
-import { ConnectorAccountProvider, IAgentRuntime, Plugin, Service } from "@elizaos/core";
-
-//#region src/types.d.ts
-/**
- * Configuration for connecting to a Shopify store via the Admin GraphQL API.
- */
-interface ShopifyPluginConfig {
-  /** Shopify store domain, e.g. "mystore.myshopify.com" */
-  storeDomain?: string;
-  /** Shopify Admin API access token */
-  accessToken?: string;
-  /** Optional default account id for multi-account config */
-  accountId?: string;
-  /** Optional per-store account records keyed by account id */
-  accounts?: Record<string, {
-    storeDomain?: string;
-    accessToken?: string;
-    label?: string;
-  }>;
-}
-interface ShopInfo {
-  name: string;
-  email: string;
-  myshopifyDomain: string;
-  plan: {
-    displayName: string;
-  };
-  currencyCode: string;
-  primaryDomain: {
-    url: string;
-  };
-}
-interface MoneyV2 {
-  amount: string;
-  currencyCode: string;
-}
-interface ShopifyImage {
-  url: string;
-  altText: string | null;
-}
-interface ProductVariant {
-  id: string;
-  title: string;
-  price: string;
-  sku: string | null;
-  inventoryQuantity: number | null;
-}
-interface ProductVariantEdge {
-  node: ProductVariant;
-}
-interface Product {
-  id: string;
-  title: string;
-  handle: string;
-  status: string;
-  descriptionHtml: string;
-  productType: string;
-  vendor: string;
-  totalInventory: number | null;
-  featuredImage: ShopifyImage | null;
-  variants: {
-    edges: ProductVariantEdge[];
-  };
-}
-interface OrderLineItem {
-  title: string;
-  quantity: number;
-  originalUnitPriceSet: {
-    shopMoney: MoneyV2;
-  };
-}
-interface OrderLineItemEdge {
-  node: OrderLineItem;
-}
-interface Order {
-  id: string;
-  name: string;
-  createdAt: string;
-  displayFinancialStatus: string | null;
-  displayFulfillmentStatus: string;
-  totalPriceSet: {
-    shopMoney: MoneyV2;
-  };
-  customer: {
-    id: string;
-    displayName: string;
-  } | null;
-  lineItems: {
-    edges: OrderLineItemEdge[];
-  };
-}
-interface Customer {
-  id: string;
-  displayName: string;
-  email: string | null;
-  phone: string | null;
-  ordersCount: string;
-  totalSpentV2: MoneyV2;
-  createdAt: string;
-}
-interface InventoryLevel {
-  id: string;
-  available: number | null;
-  location: {
-    id: string;
-    name: string;
-  };
-}
-interface Location {
-  id: string;
-  name: string;
-  isActive: boolean;
-}
-//#endregion
-//#region src/services/ShopifyService.d.ts
-declare class ShopifyService extends Service {
-  static serviceType: "shopify";
-  capabilityDescription: string;
-  private clients;
-  private defaultAccountId;
-  constructor(runtime?: IAgentRuntime);
-  stop(): Promise<void>;
-  static start(runtime: IAgentRuntime): Promise<ShopifyService>;
-  isConnected(accountId?: string): boolean;
-  private getClientState;
-  private requireClient;
-  getShop(accountId?: string): Promise<ShopInfo>;
-  listProducts(opts?: {
-    first?: number;
-    after?: string | null;
-    query?: string | null;
-  }, accountId?: string): Promise<{
-    products: Product[];
-    hasNextPage: boolean;
-    endCursor: string | null;
-  }>;
-  createProduct(input: {
-    title: string;
-    descriptionHtml?: string;
-    productType?: string;
-    vendor?: string;
-    status?: string;
-  }, accountId?: string): Promise<Product>;
-  updateProduct(id: string, input: {
-    title?: string;
-    descriptionHtml?: string;
-    productType?: string;
-    vendor?: string;
-    status?: string;
-  }, accountId?: string): Promise<Product>;
-  listOrders(opts?: {
-    first?: number;
-    after?: string | null;
-    query?: string | null;
-  }, accountId?: string): Promise<{
-    orders: Order[];
-    hasNextPage: boolean;
-    endCursor: string | null;
-  }>;
-  getOrder(id: string, accountId?: string): Promise<Order | null>;
-  fulfillOrder(orderId: string, accountId?: string): Promise<{
-    id: string;
-    status: string;
-  }>;
-  listCustomers(opts?: {
-    first?: number;
-    after?: string | null;
-    query?: string | null;
-  }, accountId?: string): Promise<{
-    customers: Customer[];
-    hasNextPage: boolean;
-    endCursor: string | null;
-  }>;
-  checkInventory(inventoryItemId: string, accountId?: string): Promise<InventoryLevel[]>;
-  adjustInventory(opts: {
-    inventoryItemId: string;
-    locationId: string;
-    delta: number;
-    reason?: string;
-  }, accountId?: string): Promise<void>;
-  listLocations(accountId?: string): Promise<Location[]>;
-  getProductCount(accountId?: string): Promise<number>;
-  getOrderCount(accountId?: string): Promise<number>;
-}
-//#endregion
-//#region src/accounts.d.ts
-declare const DEFAULT_SHOPIFY_ACCOUNT_ID = "default";
-declare const DEFAULT_SHOPIFY_ACCOUNT_ROLE = "OWNER";
-interface ShopifyAccountConfig {
-  accountId: string;
-  role: typeof DEFAULT_SHOPIFY_ACCOUNT_ROLE;
-  storeDomain: string;
-  accessToken: string;
-  label?: string;
-}
-declare function normalizeShopifyAccountId(value: unknown): string;
-declare function resolveShopifyAccountId(runtime: IAgentRuntime, options?: Record<string, unknown>): string;
-declare function readShopifyAccounts(runtime: IAgentRuntime): ShopifyAccountConfig[];
-declare function resolveShopifyAccount(accounts: readonly ShopifyAccountConfig[], accountId: string): ShopifyAccountConfig | null;
-declare function resolveShopifyDefaultAccount(accounts: readonly ShopifyAccountConfig[], accountId?: string): ShopifyAccountConfig | null;
-declare function hasShopifyAccountConfig(runtime: IAgentRuntime, options?: Record<string, unknown>): boolean;
-//#endregion
-//#region src/connector-account-provider.d.ts
-/**
- * Build the Shopify ConnectorAccountManager provider.
- */
-declare function createShopifyConnectorAccountProvider(runtime: IAgentRuntime): ConnectorAccountProvider;
-//#endregion
-//#region src/index.d.ts
-declare const shopifyPlugin: Plugin;
-//#endregion
-export { DEFAULT_SHOPIFY_ACCOUNT_ID, DEFAULT_SHOPIFY_ACCOUNT_ROLE, ShopifyAccountConfig, type ShopifyPluginConfig, ShopifyService, createShopifyConnectorAccountProvider, shopifyPlugin as default, hasShopifyAccountConfig, normalizeShopifyAccountId, readShopifyAccounts, resolveShopifyAccount, resolveShopifyAccountId, resolveShopifyDefaultAccount };
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/services/ShopifyService.ts","../src/accounts.ts","../src/connector-account-provider.ts","../src/index.ts"],"mappings":";;;;;;UAGiB,mBAAA;EAAmB;EAElC,WAAA;EAMiB;EAJjB,WAAA;EAAA;EAEA,SAAA;EAEA;EAAA,QAAA,GAAW,MAAA;IAGP,WAAA;IACA,WAAA;IACA,KAAA;EAAA;AAAA;AAAA,UASW,QAAA;EACf,IAAA;EACA,KAAA;EACA,eAAA;EACA,IAAA;IAAQ,WAAA;EAAA;EACR,YAAA;EACA,aAAA;IAAiB,GAAA;EAAA;AAAA;AAAA,UAWF,OAAA;EACf,MAAA;EACA,YAAA;AAAA;AAAA,UAOe,YAAA;EACf,GAAA;EACA,OAAA;AAAA;AAAA,UAOe,cAAA;EACf,EAAA;EACA,KAAA;EACA,KAAA;EACA,GAAA;EACA,iBAAA;AAAA;AAAA,UAGe,kBAAA;EACf,IAAA,EAAM,cAAA;AAAA;AAAA,UAGS,OAAA;EACf,EAAA;EACA,KAAA;EACA,MAAA;EACA,MAAA;EACA,eAAA;EACA,WAAA;EACA,MAAA;EACA,cAAA;EACA,aAAA,EAAe,YAAA;EACf,QAAA;IAAY,KAAA,EAAO,kBAAA;EAAA;AAAA;AAAA,UAgCJ,aAAA;EACf,KAAA;EACA,QAAA;EACA,oBAAA;IAAwB,SAAA,EAAW,OAAA;EAAA;AAAA;AAAA,UAGpB,iBAAA;EACf,IAAA,EAAM,aAAA;AAAA;AAAA,UAGS,KAAA;EACf,EAAA;EACA,IAAA;EACA,SAAA;EACA,sBAAA;EACA,wBAAA;EACA,aAAA;IAAiB,SAAA,EAAW,OAAA;EAAA;EAC5B,QAAA;IAAY,EAAA;IAAY,WAAA;EAAA;EACxB,SAAA;IAAa,KAAA,EAAO,iBAAA;EAAA;AAAA;AAAA,UAkDL,QAAA;EACf,EAAA;EACA,WAAA;EACA,KAAA;EACA,KAAA;EACA,WAAA;EACA,YAAA,EAAc,OAAA;EACd,SAAA;AAAA;AAAA,UAkBe,cAAA;EACf,EAAA;EACA,SAAA;EACA,QAAA;IAAY,EAAA;IAAY,IAAA;EAAA;AAAA;AAAA,UAsBT,QAAA;EACf,EAAA;EACA,IAAA;EACA,QAAA;AAAA;;;cC1IW,cAAA,SAAuB,OAAA;EAAA,OAC3B,WAAA;EACP,qBAAA;EAAA,QAGQ,OAAA;EAAA,QACA,gBAAA;cAEI,OAAA,GAAU,aAAA;EAIhB,IAAA,CAAA,GAAQ,OAAA;EAAA,OAIQ,KAAA,CAAM,OAAA,EAAS,aAAA,GAAgB,OAAA,CAAQ,cAAA;EA4D7D,WAAA,CAAY,SAAA;EAAA,QAIJ,cAAA;EAAA,QAuBA,aAAA;EAQF,OAAA,CAAQ,SAAA,YAAqB,OAAA,CAAQ,QAAA;EAkBrC,YAAA,CACJ,IAAA;IAAQ,KAAA;IAAgB,KAAA;IAAuB,KAAA;EAAA,GAC/C,SAAA,YACC,OAAA;IACD,QAAA,EAAU,OAAA;IACV,WAAA;IACA,SAAA;EAAA;EAyBI,aAAA,CACJ,KAAA;IACE,KAAA;IACA,eAAA;IACA,WAAA;IACA,MAAA;IACA,MAAA;EAAA,GAEF,SAAA,YACC,OAAA,CAAQ,OAAA;EA6BL,aAAA,CACJ,EAAA,UACA,KAAA;IACE,KAAA;IACA,eAAA;IACA,WAAA;IACA,MAAA;IACA,MAAA;EAAA,GAEF,SAAA,YACC,OAAA,CAAQ,OAAA;EA2BL,UAAA,CACJ,IAAA;IAAQ,KAAA;IAAgB,KAAA;IAAuB,KAAA;EAAA,GAC/C,SAAA,YACC,OAAA;IACD,MAAA,EAAQ,KAAA;IACR,WAAA;IACA,SAAA;EAAA;EAyBI,QAAA,CAAS,EAAA,UAAY,SAAA,YAAqB,OAAA,CAAQ,KAAA;EAUlD,YAAA,CACJ,OAAA,UACA,SAAA,YACC,OAAA;IAAU,EAAA;IAAY,MAAA;EAAA;EA0EnB,aAAA,CACJ,IAAA;IAAQ,KAAA;IAAgB,KAAA;IAAuB,KAAA;EAAA,GAC/C,SAAA,YACC,OAAA;IACD,SAAA,EAAW,QAAA;IACX,WAAA;IACA,SAAA;EAAA;EA6BI,cAAA,CACJ,eAAA,UACA,SAAA,YACC,OAAA,CAAQ,cAAA;EAmBL,eAAA,CACJ,IAAA;IACE,eAAA;IACA,UAAA;IACA,KAAA;IACA,MAAA;EAAA,GAEF,SAAA,YACC,OAAA;EA6BG,aAAA,CAAc,SAAA,YAAqB,OAAA,CAAQ,QAAA;EAe3C,eAAA,CAAgB,SAAA,YAAqB,OAAA;EASrC,aAAA,CAAc,SAAA,YAAqB,OAAA;AAAA;;;cCtjB9B,0BAAA;AAAA,cACA,4BAAA;AAAA,UAEI,oBAAA;EACf,SAAA;EACA,IAAA,SAAa,4BAAA;EACb,WAAA;EACA,WAAA;EACA,KAAA;AAAA;AAAA,iBAec,yBAAA,CAA0B,KAAA;AAAA,iBAI1B,uBAAA,CACd,OAAA,EAAS,aAAA,EACT,OAAA,GAAU,MAAA;AAAA,iBA0GI,mBAAA,CACd,OAAA,EAAS,aAAA,GACR,oBAAA;AAAA,iBAoDa,qBAAA,CACd,QAAA,WAAmB,oBAAA,IACnB,SAAA,WACC,oBAAA;AAAA,iBAIa,4BAAA,CACd,QAAA,WAAmB,oBAAA,IACnB,SAAA,YACC,oBAAA;AAAA,iBAWa,uBAAA,CACd,OAAA,EAAS,aAAA,EACT,OAAA,GAAU,MAAA;;;;;;iBCtCI,qCAAA,CACd,OAAA,EAAS,aAAA,GACR,wBAAA;;;cCvKG,aAAA,EAAe,MAAA"}