@teamnovu/kit-shopware-composables 0.0.3 → 0.0.5

package/api-types/storeApiSchema.localhost.http

@@ -1,4 +1,4 @@
-@baseUrl = http://localhost:8500/store-api
+@baseUrl = http://localhost:81/store-api
 @swLanguageId = 2fbb5fe2e29a4d70aa5854ce7ce3e20b
 @swIncludeSeoUrls = true
 

package/dist/helpers/checkout/index.d.ts

@@ -0,0 +1,5 @@
+export * from './useAddresses';
+export * from './useOrderDetails';
+export * from './useOrderPayment';
+export * from './usePaymentMethods';
+export * from './useShippingMethods';

package/dist/helpers/checkout/useAddresses.d.ts

@@ -0,0 +1,210 @@
+import { Schemas, components, GenericRecord } from '../../../api-types/storeApiTypes.d.ts';
+import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { ComputedRef } from 'vue';
+export declare function useCheckoutAddresses(): {
+    contextUpdateMutation: UseMutationReturnType<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown, Omit< MutationObserverIdleResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset">>;
+    contextQuery: UseQueryReturnType<{
+        apiAlias: "sales_channel_context";
+        context?: {
+            currencyFactor?: number;
+            currencyId?: string;
+            currencyPrecision?: number;
+            languageIdChain?: string[];
+            scope?: string;
+            source?: string;
+            taxState?: string;
+            useCache?: boolean;
+            versionId?: string;
+        };
+        currency?: components["schemas"]["Currency"];
+        currentCustomerGroup?: {
+            displayGross?: boolean;
+            name?: string;
+        };
+        customer?: components["schemas"]["Customer"];
+        fallbackCustomerGroup?: {
+            displayGross?: boolean;
+            name?: string;
+        };
+        paymentMethod?: components["schemas"]["PaymentMethod"];
+        salesChannel: components["schemas"]["SalesChannel"];
+        shippingLocation?: {
+            address?: components["schemas"]["CustomerAddress"];
+            apiAlias?: "cart_delivery_shipping_location";
+            country?: components["schemas"]["Country"];
+        };
+        shippingMethod?: components["schemas"]["ShippingMethod"];
+        taxRules?: {
+            name?: string;
+            taxRate?: number;
+        }[];
+        token?: string;
+    }, Error>;
+    addressListQuery: UseQueryReturnType<{
+        elements: components["schemas"]["CustomerAddress"][];
+    } & {
+        aggregations?: GenericRecord[];
+        entity?: string;
+        limit?: number;
+        page?: number;
+        total?: number;
+    }, Error>;
+    setBillingAddress: (address: Schemas["CustomerAddress"]) => Promise<void>;
+    setShippingAddress: (address: Schemas["CustomerAddress"]) => Promise<void>;
+    isSaving: ComputedRef<boolean>;
+    activeBillingAddress: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customerId: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        zipcode?: string;
+    } | undefined>;
+    activeShippingAddress: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customerId: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        zipcode?: string;
+    } | undefined>;
+    inactiveBillingAddresses: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customerId: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        zipcode?: string;
+    }[]>;
+    inactiveShippingAddresses: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customerId: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        zipcode?: string;
+    }[]>;
+};

package/dist/helpers/checkout/useOrderDetails.d.ts

@@ -0,0 +1,185 @@
+import { MaybeRef, ComputedRef } from 'vue';
+import { Schemas } from '../../query/types';
+import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { UseQueryReturnType } from '@tanstack/vue-query';
+export declare function useOrderDetails(orderId: MaybeRef<string>, criteria?: Schemas['Criteria']): {
+    order: ComputedRef<{
+        addresses?: components["schemas"]["OrderAddress"][];
+        affiliateCode?: string;
+        readonly amountNet?: number;
+        readonly amountTotal?: number;
+        billingAddress?: components["schemas"]["OrderAddress"];
+        billingAddressId: string;
+        billingAddressVersionId?: string;
+        campaignCode?: string;
+        readonly createdAt?: string;
+        createdById?: string;
+        currency?: components["schemas"]["Currency"];
+        currencyFactor: number;
+        currencyId: string;
+        customerComment?: string;
+        customFields?: GenericRecord;
+        deepLinkCode?: string;
+        deliveries?: components["schemas"]["OrderDelivery"][];
+        documents: components["schemas"]["Document"][];
+        id: string;
+        language?: components["schemas"]["Language"];
+        languageId: string;
+        lineItems?: components["schemas"]["OrderLineItem"][];
+        orderCustomer?: components["schemas"]["OrderCustomer"];
+        readonly orderDate: string;
+        orderDateTime: string;
+        orderNumber?: string;
+        readonly positionPrice?: number;
+        price: components["schemas"]["CalculatedPrice"];
+        salesChannelId: string;
+        shippingCosts?: {
+            calculatedTaxes?: GenericRecord;
+            listPrice?: {
+                discount?: number;
+                percentage?: number;
+                price?: number;
+            };
+            quantity: number;
+            referencePrice?: GenericRecord;
+            regulationPrice?: {
+                price?: number;
+            };
+            taxRules?: GenericRecord;
+            totalPrice: number;
+            unitPrice: number;
+        };
+        readonly shippingTotal?: number;
+        source?: string;
+        stateMachineState: components["schemas"]["StateMachineState"];
+        tags?: components["schemas"]["Tag"][];
+        readonly taxStatus?: string;
+        transactions?: components["schemas"]["OrderTransaction"][];
+        readonly updatedAt?: string;
+        updatedById?: string;
+        versionId?: string;
+    } | undefined>;
+    status: ComputedRef<string | undefined>;
+    statusTechnicalName: ComputedRef<string | undefined>;
+    total: ComputedRef<number | undefined>;
+    subtotal: ComputedRef<number | undefined>;
+    shippingCosts: ComputedRef<number | undefined>;
+    shippingAddress: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        vatId?: string;
+        versionId?: string;
+        zipcode?: string;
+    } | undefined>;
+    billingAddress: ComputedRef<{
+        additionalAddressLine1?: string;
+        additionalAddressLine2?: string;
+        city: string;
+        company?: string;
+        country?: components["schemas"]["Country"];
+        countryId: string;
+        countryState?: components["schemas"]["CountryState"];
+        countryStateId?: string;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        department?: string;
+        firstName: string;
+        hash?: string;
+        id: string;
+        lastName: string;
+        phoneNumber?: string;
+        salutation?: components["schemas"]["Salutation"];
+        street: string;
+        title?: string;
+        readonly updatedAt?: string;
+        vatId?: string;
+        versionId?: string;
+        zipcode?: string;
+    } | undefined>;
+    personalDetails: ComputedRef<{
+        email: string | undefined;
+        firstName: string | undefined;
+        lastName: string | undefined;
+    }>;
+    shippingMethod: ComputedRef<{
+        active?: boolean;
+        availabilityRule?: components["schemas"]["Rule"];
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        deliveryTime?: components["schemas"]["DeliveryTime"];
+        deliveryTimeId: string;
+        description?: string;
+        id: string;
+        media?: components["schemas"]["Media"];
+        mediaId?: string;
+        name: string;
+        position?: number;
+        prices?: components["schemas"]["ShippingMethodPrice"][];
+        tags?: components["schemas"]["Tag"][];
+        tax?: components["schemas"]["Tax"];
+        taxType?: string;
+        technicalName: string;
+        trackingUrl?: string;
+        translated: {
+            deliveryTimeId: string;
+            description: string;
+            mediaId: string;
+            name: string;
+            taxType: string;
+            technicalName: string;
+            trackingUrl: string;
+        };
+        readonly updatedAt?: string;
+    } | undefined>;
+    paymentMethod: ComputedRef<{
+        active?: boolean;
+        afterOrderEnabled?: boolean;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        description?: string;
+        readonly distinguishableName?: string;
+        id: string;
+        media?: components["schemas"]["Media"];
+        mediaId?: string;
+        name: string;
+        position?: number;
+        shortName?: string;
+        technicalName: string;
+        translated: {
+            description: string;
+            distinguishableName: string;
+            mediaId: string;
+            name: string;
+            shortName: string;
+            technicalName: string;
+        };
+        readonly updatedAt?: string;
+    } | undefined>;
+    paymentChangeable: ComputedRef<boolean>;
+    orderQuery: UseQueryReturnType<{
+        orders: {
+            elements: components["schemas"]["Order"][];
+        } & components["schemas"]["EntitySearchResult"];
+        paymentChangeable?: {
+            [key: string]: boolean;
+        };
+    }, Error>;
+};

package/dist/helpers/checkout/useOrderPayment.d.ts

@@ -0,0 +1,73 @@
+import { MaybeRef, ComputedRef } from 'vue';
+import { Schemas } from '../../query/types';
+import { GenericRecord, components } from '../../../api-types/storeApiTypes';
+export declare function useOrderPayment(order: MaybeRef<Schemas['Order'] | null | undefined>): {
+    isAsynchronous: ComputedRef<any>;
+    activeTransaction: ComputedRef<{
+        amount: {
+            calculatedTaxes?: GenericRecord;
+            listPrice?: {
+                discount?: number;
+                percentage?: number;
+                price?: number;
+            };
+            quantity: number;
+            referencePrice?: GenericRecord;
+            regulationPrice?: {
+                price?: number;
+            };
+            taxRules?: GenericRecord;
+            totalPrice: number;
+            unitPrice: number;
+        };
+        captures?: components["schemas"]["OrderTransactionCapture"][];
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        id: string;
+        orderId: string;
+        orderVersionId?: string;
+        paymentMethod?: components["schemas"]["PaymentMethod"];
+        paymentMethodId: string;
+        stateId: string;
+        stateMachineState?: components["schemas"]["StateMachineState"];
+        readonly updatedAt?: string;
+        validationData?: GenericRecord;
+        versionId?: string;
+    } | undefined>;
+    state: ComputedRef<{
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        id?: string;
+        name: string;
+        technicalName: string;
+        translated: {
+            name: string;
+            technicalName: string;
+        };
+        readonly updatedAt?: string;
+    } | undefined>;
+    paymentMethod: ComputedRef<{
+        active?: boolean;
+        afterOrderEnabled?: boolean;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        description?: string;
+        readonly distinguishableName?: string;
+        id: string;
+        media?: components["schemas"]["Media"];
+        mediaId?: string;
+        name: string;
+        position?: number;
+        shortName?: string;
+        technicalName: string;
+        translated: {
+            description: string;
+            distinguishableName: string;
+            mediaId: string;
+            name: string;
+            shortName: string;
+            technicalName: string;
+        };
+        readonly updatedAt?: string;
+    } | undefined>;
+};

package/dist/helpers/checkout/usePaymentMethods.d.ts

@@ -0,0 +1,155 @@
+import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { ComputedRef } from 'vue';
+export declare function usePaymentMethods(): {
+    contextUpdateMutation: UseMutationReturnType<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown, Omit< MutationObserverIdleResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
+        redirectUrl?: string;
+    }, unknown, {
+        billingAddressId?: string;
+        countryId?: string;
+        countryStateId?: string;
+        currencyId?: string;
+        languageId?: string;
+        paymentMethodId?: string;
+        shippingAddressId?: string;
+        shippingMethodId?: string;
+    }, unknown>, "mutate" | "reset">>;
+    contextQuery: UseQueryReturnType<{
+        apiAlias: "sales_channel_context";
+        context?: {
+            currencyFactor?: number;
+            currencyId?: string;
+            currencyPrecision?: number;
+            languageIdChain?: string[];
+            scope?: string;
+            source?: string;
+            taxState?: string;
+            useCache?: boolean;
+            versionId?: string;
+        };
+        currency?: components["schemas"]["Currency"];
+        currentCustomerGroup?: {
+            displayGross?: boolean;
+            name?: string;
+        };
+        customer?: components["schemas"]["Customer"];
+        fallbackCustomerGroup?: {
+            displayGross?: boolean;
+            name?: string;
+        };
+        paymentMethod?: components["schemas"]["PaymentMethod"];
+        salesChannel: components["schemas"]["SalesChannel"];
+        shippingLocation?: {
+            address?: components["schemas"]["CustomerAddress"];
+            apiAlias?: "cart_delivery_shipping_location";
+            country?: components["schemas"]["Country"];
+        };
+        shippingMethod?: components["schemas"]["ShippingMethod"];
+        taxRules?: {
+            name?: string;
+            taxRate?: number;
+        }[];
+        token?: string;
+    }, Error>;
+    paymentMethodsQuery: UseQueryReturnType<{
+        aggregations?: GenericRecord;
+        elements?: components["schemas"]["PaymentMethod"][];
+        total?: number;
+    }, Error>;
+    activePaymentMethod: ComputedRef<{
+        active?: boolean;
+        afterOrderEnabled?: boolean;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        description?: string;
+        readonly distinguishableName?: string;
+        id: string;
+        media?: components["schemas"]["Media"];
+        mediaId?: string;
+        name: string;
+        position?: number;
+        shortName?: string;
+        technicalName: string;
+        translated: {
+            description: string;
+            distinguishableName: string;
+            mediaId: string;
+            name: string;
+            shortName: string;
+            technicalName: string;
+        };
+        readonly updatedAt?: string;
+    } | undefined>;
+    setPaymentMethod: (paymentMethodId: string) => Promise<{
+        redirectUrl?: string;
+    }>;
+    isSaving: ComputedRef<boolean>;
+    paymentMethods: ComputedRef<{
+        active?: boolean;
+        afterOrderEnabled?: boolean;
+        readonly createdAt?: string;
+        customFields?: GenericRecord;
+        description?: string;
+        readonly distinguishableName?: string;
+        id: string;
+        media?: components["schemas"]["Media"];
+        mediaId?: string;
+        name: string;
+        position?: number;
+        shortName?: string;
+        technicalName: string;
+        translated: {
+            description: string;
+            distinguishableName: string;
+            mediaId: string;
+            name: string;
+            shortName: string;
+            technicalName: string;
+        };
+        readonly updatedAt?: string;
+    }[] | undefined>;
+};