@vendure/mcp-plugin 3.8.0-minor-bootstrap.0

package/lib/tools/built-in/serializer.service.d.ts

@@ -0,0 +1,327 @@
+import { PaymentMethodQuote, ShippingMethodQuote } from '@vendure/common/lib/generated-types';
+import { Address, Asset, Channel, Collection, ConfigService, CurrencyCode, Customer, CustomerGroup, Fulfillment, FulfillmentLine, GraphQLErrorResult, ID, Order, Payment, Product, ProductOptionGroup, ProductVariant, Refund, StockLevel } from '@vendure/core';
+export declare class McpToolSerializerService {
+    private readonly configService;
+    constructor(configService: ConfigService);
+    decimal(value: number | undefined | null): string;
+    private isoDate;
+    variant(variant: ProductVariant | undefined | null): {
+        id: ID;
+        name: import("@vendure/core").LocaleString;
+        sku: string;
+        enabled: boolean;
+        price: number;
+        priceDecimal: string;
+        priceWithTax: number;
+        priceWithTaxDecimal: string;
+        currencyCode: CurrencyCode;
+    } | null;
+    adminVariant(variant: ProductVariant, stockOnHand: number): {
+        stockOnHand: number;
+        id?: ID | undefined;
+        name?: import("@vendure/core").LocaleString | undefined;
+        sku?: string | undefined;
+        enabled?: boolean | undefined;
+        price?: number | undefined;
+        priceDecimal?: string | undefined;
+        priceWithTax?: number | undefined;
+        priceWithTaxDecimal?: string | undefined;
+        currencyCode?: CurrencyCode | undefined;
+    };
+    product(product: Product | undefined | null): {
+        id: ID;
+        name: import("@vendure/core").LocaleString;
+        slug: import("@vendure/core").LocaleString;
+        description: import("@vendure/core").LocaleString;
+        enabled: boolean;
+        featuredAsset: {
+            id: ID;
+            name: import("@vendure/core").LocaleString;
+            type: import("@vendure/core").AssetType;
+            mimeType: string;
+            width: number;
+            height: number;
+            fileSize: number;
+            source: string;
+            preview: string;
+            focalPoint: {
+                x: number;
+                y: number;
+            } | undefined;
+        } | null;
+    } | null;
+    productListItem(product: Product, variants: ProductVariant[]): {
+        id: ID;
+        name: import("@vendure/core").LocaleString;
+        slug: import("@vendure/core").LocaleString;
+        description: string;
+        enabled: boolean;
+        featuredAsset: {
+            id: ID;
+            preview: string;
+        } | null;
+        priceRange: {
+            min: number;
+            minDecimal: string;
+            max: number;
+            maxDecimal: string;
+            currencyCode: CurrencyCode;
+        } | null;
+    };
+    private priceRange;
+    optionGroup(group: ProductOptionGroup): {
+        id: ID;
+        code: string;
+        name: import("@vendure/core").LocaleString;
+        options: {
+            id: ID;
+            code: string;
+            name: import("@vendure/core").LocaleString;
+        }[];
+    };
+    stockLevel(level: StockLevel): {
+        stockLocationId: ID;
+        stockLocationName: string;
+        stockOnHand: number;
+        stockAllocated: number;
+    };
+    collection(collection: Collection | undefined | null): {
+        id: ID;
+        name: import("@vendure/core").LocaleString;
+        slug: import("@vendure/core").LocaleString;
+        description: import("@vendure/core").LocaleString;
+        featuredAsset: {
+            id: ID;
+            name: import("@vendure/core").LocaleString;
+            type: import("@vendure/core").AssetType;
+            mimeType: string;
+            width: number;
+            height: number;
+            fileSize: number;
+            source: string;
+            preview: string;
+            focalPoint: {
+                x: number;
+                y: number;
+            } | undefined;
+        } | null;
+    } | null;
+    channel(channel: Channel): {
+        id: ID;
+        code: string;
+        token: string;
+    };
+    customer(customer: Customer | undefined | null, addresses?: Address[]): {
+        id: ID;
+        firstName: string;
+        lastName: string;
+        emailAddress: string;
+        phoneNumber: string;
+        addresses: {
+            defaultShippingAddress: boolean;
+            defaultBillingAddress: boolean;
+            id: ID;
+        }[] | undefined;
+    } | null;
+    private customerAddress;
+    /** A customer group, whose ID is what `add_customer_to_group` takes. */
+    customerGroup(group: CustomerGroup): {
+        id: ID;
+        name: string;
+    };
+    customerOrError(result: Customer | GraphQLErrorResult): {
+        customer: {
+            id: ID;
+            firstName: string;
+            lastName: string;
+            emailAddress: string;
+            phoneNumber: string;
+            addresses: {
+                defaultShippingAddress: boolean;
+                defaultBillingAddress: boolean;
+                id: ID;
+            }[] | undefined;
+        } | null;
+    } | {
+        errorCode: string;
+        message: string;
+        customer?: undefined;
+    };
+    payment(payment: Payment): {
+        id: ID;
+        method: string;
+        amount: number;
+        amountDecimal: string;
+        state: import("@vendure/core").PaymentState;
+        transactionId: string;
+        errorMessage: string | undefined;
+        publicMetadata: any;
+        refunds: {
+            id: ID;
+            state: import("@vendure/core").RefundState;
+            total: number;
+            totalDecimal: string;
+            reason: string;
+        }[];
+    };
+    fulfillment(fulfillment: Fulfillment, lines: FulfillmentLine[]): {
+        id: ID;
+        state: import("@vendure/core").FulfillmentState;
+        method: string;
+        trackingCode: string;
+        lines: {
+            orderLineId: ID;
+            quantity: number;
+        }[];
+    };
+    refund(refund: Refund, currencyCode: CurrencyCode): {
+        id: ID;
+        state: import("@vendure/core").RefundState;
+        total: number;
+        totalDecimal: string;
+        currencyCode: CurrencyCode;
+        reason: string;
+        paymentId: ID;
+    };
+    private orderAddress;
+    private address;
+    orderNote(entry: {
+        id: ID;
+        data: {
+            note: string;
+        };
+        isPublic: boolean;
+        createdAt: Date;
+    }): {
+        id: ID;
+        text: string;
+        isPublic: boolean;
+        createdAt: string | null;
+    };
+    order(order: Order | undefined | null): {
+        id: ID;
+        code: string;
+        state: import("@vendure/core").OrderState;
+        active: boolean;
+        total: number;
+        totalDecimal: string;
+        totalWithTax: number;
+        totalWithTaxDecimal: string;
+        currencyCode: CurrencyCode;
+        totalQuantity: number;
+        createdAt: string | null;
+        updatedAt: string | null;
+        orderPlacedAt: string | null;
+        couponCodes: string[];
+        discounts: {
+            adjustmentSource: string;
+            type: import("@vendure/core").AdjustmentType;
+            description: string;
+            amount: number;
+            amountDecimal: string;
+            amountWithTax: number;
+            amountWithTaxDecimal: string;
+        }[];
+        lines: {
+            id: ID;
+            quantity: number;
+            linePriceWithTax: number;
+            linePriceWithTaxDecimal: string;
+            productVariant: {
+                id: ID;
+                name: import("@vendure/core").LocaleString;
+                sku: string;
+            } | null;
+        }[];
+        payments: {
+            id: ID;
+            method: string;
+            amount: number;
+            amountDecimal: string;
+            state: import("@vendure/core").PaymentState;
+            transactionId: string;
+            errorMessage: string | undefined;
+            publicMetadata: any;
+            refunds: {
+                id: ID;
+                state: import("@vendure/core").RefundState;
+                total: number;
+                totalDecimal: string;
+                reason: string;
+            }[];
+        }[] | undefined;
+        fulfillments: {
+            id: ID;
+            state: import("@vendure/core").FulfillmentState;
+            method: string;
+            trackingCode: string;
+            lines: {
+                orderLineId: ID;
+                quantity: number;
+            }[];
+        }[] | undefined;
+        customer: {
+            id: ID;
+            emailAddress: string;
+            firstName: string;
+            lastName: string;
+        } | null | undefined;
+        shippingAddress: Record<string, string> | null;
+        billingAddress: Record<string, string> | null;
+        shippingWithTax: number;
+        shippingWithTaxDecimal: string;
+        shippingLines: {
+            id: ID;
+            shippingMethodId: ID | null;
+            priceWithTax: number;
+            priceWithTaxDecimal: string;
+        }[] | undefined;
+    } | null;
+    private orderCustomer;
+    orderOrError(result: Order | GraphQLErrorResult): Record<string, unknown>;
+    shippingQuote(quote: ShippingMethodQuote, currencyCode: CurrencyCode): {
+        customFields: Record<string, unknown> | null | undefined;
+        priceDecimal: string;
+        priceWithTaxDecimal: string;
+        currencyCode: CurrencyCode;
+        __typename?: "ShippingMethodQuote";
+        code: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+        description: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+        id: import("@vendure/common/lib/generated-types").Scalars["ID"]["output"];
+        metadata?: import("@vendure/common/lib/generated-types").Maybe<import("@vendure/common/lib/generated-types").Scalars["JSON"]["output"]>;
+        name: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+        price: import("@vendure/common/lib/generated-types").Scalars["Money"]["output"];
+        priceWithTax: import("@vendure/common/lib/generated-types").Scalars["Money"]["output"];
+    };
+    /** Same as `shippingQuote`: copies the quote and cuts `customFields` to what the Shop API shows. */
+    paymentQuote(quote: PaymentMethodQuote): {
+        customFields: Record<string, unknown> | null | undefined;
+        __typename?: "PaymentMethodQuote";
+        code: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+        description: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+        eligibilityMessage?: import("@vendure/common/lib/generated-types").Maybe<import("@vendure/common/lib/generated-types").Scalars["String"]["output"]>;
+        id: import("@vendure/common/lib/generated-types").Scalars["ID"]["output"];
+        isEligible: import("@vendure/common/lib/generated-types").Scalars["Boolean"]["output"];
+        name: import("@vendure/common/lib/generated-types").Scalars["String"]["output"];
+    };
+    private shopVisibleCustomFields;
+    /**
+     * Called directly by `upload_asset`, and from `product()` and `collection()` for the asset
+     * fields they carry.
+     */
+    asset(asset: Asset): {
+        id: ID;
+        name: import("@vendure/core").LocaleString;
+        type: import("@vendure/core").AssetType;
+        mimeType: string;
+        width: number;
+        height: number;
+        fileSize: number;
+        source: string;
+        preview: string;
+        focalPoint: {
+            x: number;
+            y: number;
+        } | undefined;
+    };
+}