@teamnovu/kit-shopware-composables 0.0.3 → 0.0.4

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

@@ -0,0 +1,173 @@
+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 useShippingMethods(): {
+    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>;
+    shippingMethodsQuery: UseQueryReturnType<{
+        aggregations?: GenericRecord;
+        elements: components["schemas"]["ShippingMethod"][];
+        total?: number;
+    } & {
+        aggregations?: GenericRecord[];
+        entity?: string;
+        limit?: number;
+        page?: number;
+        total?: number;
+    }, Error>;
+    activeShippingMethod: 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>;
+    setShippingMethod: (shippingMethodId: string) => Promise<{
+        redirectUrl?: string;
+    }>;
+    isSaving: ComputedRef<boolean>;
+    shippingMethods: 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>;
+};

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

@@ -0,0 +1,2 @@
+export * from './useSeoUrl';
+export * from './usePagination';

package/dist/{usePagination.d.ts → helpers/general/usePagination.d.ts}

@@ -1,4 +1,4 @@
-import { Schemas } from '../api-types/storeApiTypes.d.ts';
+import { Schemas } from '../../../api-types/storeApiTypes.d.ts';
 import { MaybeRef, Ref, ComputedRef } from 'vue';
 interface PaginationOptions {
     page?: MaybeRef<number>;

package/dist/{general → helpers/general}/useSeoUrl.d.ts

@@ -1,4 +1,4 @@
-import { GenericRecord } from '../../api-types/storeApiTypes.d.ts';
+import { GenericRecord } from '../../../api-types/storeApiTypes.d.ts';
 import { MaybeRef, ComputedRef } from 'vue';
 interface SeoUrlEntity {
     extensions?: {

package/dist/helpers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './checkout';
+export * from './general';
+export * from './product';
+export * from './user';

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

@@ -0,0 +1,2 @@
+export * from './useProductPrice';
+export * from './useProductVariantForOptions';

package/dist/helpers/product/useProductPrice.d.ts

@@ -0,0 +1,61 @@
+import { Schemas, components } from '../../../api-types/storeApiTypes.d.ts';
+import { ComputedRef, Ref } from 'vue';
+import { TierPrice } from '@shopware/helpers';
+/**
+ * The purpose of the `useProductPrice` function is to abstract the logic
+ * to expose most useful helpers for price displaying.
+ *
+ * @public
+ * @category Product
+ */
+export declare function useProductPrice(product: Ref<Schemas['Product'] | undefined>): {
+    price: ComputedRef<{
+        apiAlias: "calculated_price";
+        calculatedTaxes: {
+            apiAlias: "cart_tax_calculated";
+            price: number;
+            tax: number;
+            taxRate: number;
+        }[];
+        hasRange: boolean;
+        listPrice: components["schemas"]["CartListPrice"] | null;
+        netPrice: number;
+        positionPrice: number;
+        quantity: number;
+        rawTotal: number;
+        referencePrice: components["schemas"]["CartPriceReference"] | null;
+        regulationPrice: {
+            apiAlias?: "cart_regulation_price";
+            price?: number;
+        } | null;
+        taxRules: {
+            name?: string;
+            taxRate?: number;
+        }[];
+        taxStatus: "net" | "tax-free";
+        totalPrice: number;
+        unitPrice: number;
+        variantId?: string | null;
+    } | undefined>;
+    totalPrice: ComputedRef<number | undefined>;
+    unitPrice: ComputedRef<number | undefined>;
+    displayFromVariants: ComputedRef<number | false | undefined>;
+    displayFrom: ComputedRef<boolean>;
+    tierPrices: ComputedRef< TierPrice[]>;
+    referencePrice: ComputedRef<{
+        apiAlias: "cart_price_reference";
+        hasRange: boolean;
+        listPrice: components["schemas"]["CartListPrice"] | null;
+        price?: number;
+        purchaseUnit?: number;
+        referenceUnit?: number;
+        regulationPrice: {
+            apiAlias?: "cart_regulation_price";
+            price?: number;
+        } | null;
+        unitName: string;
+        variantId?: string | null;
+    } | null | undefined>;
+    isListPrice: ComputedRef<boolean>;
+    regulationPrice: ComputedRef<number | undefined>;
+};

package/dist/{products → helpers/product}/useProductVariantForOptions.d.ts

@@ -1,4 +1,4 @@
-import { Schemas, components, GenericRecord } from '../../api-types/storeApiTypes.d.ts';
+import { Schemas, components, GenericRecord } from '../../../api-types/storeApiTypes.d.ts';
 import { MaybeRef, ComputedRef } from 'vue';
 type DetailProduct<S extends Schemas> = S['CustomProductDetailResponse']['product'];
 export declare function getProductVariantForOptions<S extends Schemas>(product: DetailProduct<S>, optionIds: string[]): {

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

@@ -0,0 +1,2 @@
+export * from './useIsLoggedIn';
+export * from './useUser';

package/dist/helpers/user/useIsLoggedIn.d.ts

@@ -0,0 +1,2 @@
+import { ComputedRef } from 'vue';
+export declare function useIsLoggedIn(): ComputedRef<boolean>;

package/dist/helpers/user/useUser.d.ts

@@ -0,0 +1,167 @@
+import { Schemas } from '../../query/types';
+import { ComputedRef } from 'vue';
+import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { UseQueryReturnType } from '@tanstack/vue-query';
+export declare function useUser(criteria?: Schemas['Criteria']): {
+    user: ComputedRef<({
+        active?: boolean;
+        activeBillingAddress: components["schemas"]["CustomerAddress"];
+        activeShippingAddress: components["schemas"]["CustomerAddress"];
+        addresses?: components["schemas"]["CustomerAddress"][];
+        affiliateCode?: string;
+        apiAlias: "customer";
+        birthday?: string;
+        campaignCode?: string;
+        readonly createdAt?: string;
+        createdById?: string;
+        customerNumber: string;
+        customFields?: GenericRecord;
+        defaultBillingAddress?: components["schemas"]["CustomerAddress"];
+        defaultBillingAddressId: string;
+        defaultShippingAddress?: components["schemas"]["CustomerAddress"];
+        defaultShippingAddressId: string;
+        doubleOptInConfirmDate?: string;
+        doubleOptInEmailSentDate?: string;
+        doubleOptInRegistration?: boolean;
+        email: string;
+        firstLogin?: string;
+        firstName: string;
+        group?: components["schemas"]["CustomerGroup"];
+        groupId: string;
+        guest?: boolean;
+        hash?: string;
+        id: string;
+        language?: components["schemas"]["Language"];
+        languageId: string;
+        lastLogin?: string;
+        lastName: string;
+        readonly lastOrderDate?: string;
+        lastPaymentMethod?: components["schemas"]["PaymentMethod"];
+        lastPaymentMethodId?: string;
+        readonly orderCount?: number;
+        readonly orderTotalAmount?: number;
+        readonly reviewCount?: number;
+        salesChannelId: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        readonly tagIds?: string[];
+        tags?: components["schemas"]["Tag"][];
+        title?: string;
+        readonly updatedAt?: string;
+        updatedById?: string;
+    } & ({
+        accountType: "private";
+    } | {
+        accountType: "business";
+        company: string;
+        vatIds: [string, ...string[]];
+    })) | undefined>;
+    isLoggedIn: ComputedRef<boolean>;
+    isCustomerSession: ComputedRef<boolean>;
+    isGuestSession: ComputedRef<boolean>;
+    defaultBillingAddressId: ComputedRef<string | null>;
+    defaultShippingAddressId: ComputedRef<string | null>;
+    userDefaultBillingAddress: 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;
+    } | null>;
+    userDefaultShippingAddress: 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;
+    } | null>;
+    customerQuery: UseQueryReturnType<{
+        active?: boolean;
+        activeBillingAddress: components["schemas"]["CustomerAddress"];
+        activeShippingAddress: components["schemas"]["CustomerAddress"];
+        addresses?: components["schemas"]["CustomerAddress"][];
+        affiliateCode?: string;
+        apiAlias: "customer";
+        birthday?: string;
+        campaignCode?: string;
+        readonly createdAt?: string;
+        createdById?: string;
+        customerNumber: string;
+        customFields?: GenericRecord;
+        defaultBillingAddress?: components["schemas"]["CustomerAddress"];
+        defaultBillingAddressId: string;
+        defaultShippingAddress?: components["schemas"]["CustomerAddress"];
+        defaultShippingAddressId: string;
+        doubleOptInConfirmDate?: string;
+        doubleOptInEmailSentDate?: string;
+        doubleOptInRegistration?: boolean;
+        email: string;
+        firstLogin?: string;
+        firstName: string;
+        group?: components["schemas"]["CustomerGroup"];
+        groupId: string;
+        guest?: boolean;
+        hash?: string;
+        id: string;
+        language?: components["schemas"]["Language"];
+        languageId: string;
+        lastLogin?: string;
+        lastName: string;
+        readonly lastOrderDate?: string;
+        lastPaymentMethod?: components["schemas"]["PaymentMethod"];
+        lastPaymentMethodId?: string;
+        readonly orderCount?: number;
+        readonly orderTotalAmount?: number;
+        readonly reviewCount?: number;
+        salesChannelId: string;
+        salutation?: components["schemas"]["Salutation"];
+        salutationId?: string;
+        readonly tagIds?: string[];
+        tags?: components["schemas"]["Tag"][];
+        title?: string;
+        readonly updatedAt?: string;
+        updatedById?: string;
+    } & ({
+        accountType: "private";
+    } | {
+        accountType: "business";
+        company: string;
+        vatIds: [string, ...string[]];
+    }), Error>;
+};