@elizaos/plugin-shopify 2.0.3-beta.5 → 2.0.3-beta.7

package/dist/index.d.ts

@@ -0,0 +1,219 @@
+import { Service, IAgentRuntime, ConnectorAccountProvider, Plugin } from '@elizaos/core';
+
+/**
+ * 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;
+}
+
+declare class ShopifyService extends Service {
+    static serviceType: "shopify";
+    capabilityDescription: string;
+    private clients;
+    private defaultAccountId;
+    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>;
+}
+
+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;
+
+/**
+ * Shopify ConnectorAccountManager provider.
+ *
+ * Bridges plugin-shopify to the @elizaos/core ConnectorAccountManager so the
+ * generic HTTP CRUD + OAuth surface can list, create, patch, delete, and run
+ * the OAuth flow for Shopify stores.
+ *
+ * Account model:
+ *   - role "OWNER" — store admin (Shopify Admin API access token)
+ *   - accountKey  — store domain (e.g. mystore.myshopify.com)
+ *   - purpose     — ["admin"]
+ */
+
+/**
+ * Build the Shopify ConnectorAccountManager provider.
+ */
+declare function createShopifyConnectorAccountProvider(runtime: IAgentRuntime): ConnectorAccountProvider;
+
+declare const shopifyPlugin: Plugin;
+
+export { DEFAULT_SHOPIFY_ACCOUNT_ID, DEFAULT_SHOPIFY_ACCOUNT_ROLE, type ShopifyAccountConfig, type ShopifyPluginConfig, ShopifyService, createShopifyConnectorAccountProvider, shopifyPlugin as default, hasShopifyAccountConfig, normalizeShopifyAccountId, readShopifyAccounts, resolveShopifyAccount, resolveShopifyAccountId, resolveShopifyDefaultAccount };