@teamnovu/kit-shopware-composables 0.0.5 → 0.0.6

package/dist/global.d.ts

@@ -0,0 +1,8 @@
+declare global {
+  namespace ShopwareApi {
+    export interface Operations {}
+    export interface Schemas {}
+  }
+}
+
+export {}

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

@@ -1,10 +1,12 @@
 import { Schemas, components, GenericRecord } from '../../../api-types/storeApiTypes.d.ts';
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { ShopwareApiError, BrandedResponse } from '@teamnovu/kit-shopware-api-client';
+import { Operations } from '../..';
 import { ComputedRef } from 'vue';
 export declare function useCheckoutAddresses(): {
     contextUpdateMutation: UseMutationReturnType<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,7 +17,7 @@ export declare function useCheckoutAddresses(): {
         shippingMethodId?: string;
     }, unknown, Omit< MutationObserverIdleResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,7 +28,7 @@ export declare function useCheckoutAddresses(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,7 +39,7 @@ export declare function useCheckoutAddresses(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,7 +50,7 @@ export declare function useCheckoutAddresses(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -58,52 +60,8 @@ export declare function useCheckoutAddresses(): {
         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>;
+    contextQuery: UseQueryReturnType<BrandedResponse<Operations, "readContext get /context">, Error>;
+    addressListQuery: UseQueryReturnType<BrandedResponse<Operations, "listAddress post /account/list-address">, Error>;
     setBillingAddress: (address: Schemas["CustomerAddress"]) => Promise<void>;
     setShippingAddress: (address: Schemas["CustomerAddress"]) => Promise<void>;
     isSaving: ComputedRef<boolean>;

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

@@ -2,6 +2,8 @@ import { MaybeRef, ComputedRef } from 'vue';
 import { Schemas } from '../../query/types';
 import { components, GenericRecord } from '../../../api-types/storeApiTypes';
 import { UseQueryReturnType } from '@tanstack/vue-query';
+import { BrandedResponse } from '@teamnovu/kit-shopware-api-client';
+import { Operations } from '../..';
 export declare function useOrderDetails(orderId: MaybeRef<string>, criteria?: Schemas['Criteria']): {
     order: ComputedRef<{
         addresses?: components["schemas"]["OrderAddress"][];
@@ -174,12 +176,5 @@ export declare function useOrderDetails(orderId: MaybeRef<string>, criteria?: Sc
         readonly updatedAt?: string;
     } | undefined>;
     paymentChangeable: ComputedRef<boolean>;
-    orderQuery: UseQueryReturnType<{
-        orders: {
-            elements: components["schemas"]["Order"][];
-        } & components["schemas"]["EntitySearchResult"];
-        paymentChangeable?: {
-            [key: string]: boolean;
-        };
-    }, Error>;
+    orderQuery: UseQueryReturnType<BrandedResponse<Operations, "readOrder post /order">, Error>;
 };

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

@@ -1,10 +1,12 @@
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
-import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { ShopwareApiError, BrandedResponse } from '@teamnovu/kit-shopware-api-client';
+import { Operations } from '../..';
 import { ComputedRef } from 'vue';
+import { GenericRecord, components } from '../../../api-types/storeApiTypes';
 export declare function usePaymentMethods(): {
     contextUpdateMutation: UseMutationReturnType<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,7 +17,7 @@ export declare function usePaymentMethods(): {
         shippingMethodId?: string;
     }, unknown, Omit< MutationObserverIdleResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,7 +28,7 @@ export declare function usePaymentMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,7 +39,7 @@ export declare function usePaymentMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,7 +50,7 @@ export declare function usePaymentMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -58,48 +60,8 @@ export declare function usePaymentMethods(): {
         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>;
+    contextQuery: UseQueryReturnType<BrandedResponse<Operations, "readContext get /context">, Error>;
+    paymentMethodsQuery: UseQueryReturnType<BrandedResponse<Operations, "readPaymentMethod post /payment-method">, Error>;
     activePaymentMethod: ComputedRef<{
         active?: boolean;
         afterOrderEnabled?: boolean;
@@ -151,5 +113,5 @@ export declare function usePaymentMethods(): {
             technicalName: string;
         };
         readonly updatedAt?: string;
-    }[] | undefined>;
+    }[]>;
 };

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

@@ -1,10 +1,12 @@
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
-import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { ShopwareApiError, BrandedResponse } from '@teamnovu/kit-shopware-api-client';
+import { Operations } from '../..';
 import { ComputedRef } from 'vue';
+import { components, GenericRecord } from '../../../api-types/storeApiTypes';
 export declare function useShippingMethods(): {
     contextUpdateMutation: UseMutationReturnType<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,7 +17,7 @@ export declare function useShippingMethods(): {
         shippingMethodId?: string;
     }, unknown, Omit< MutationObserverIdleResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,7 +28,7 @@ export declare function useShippingMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,7 +39,7 @@ export declare function useShippingMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,7 +50,7 @@ export declare function useShippingMethods(): {
         shippingMethodId?: string;
     }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
         redirectUrl?: string;
-    }, unknown, {
+    }, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -58,54 +60,8 @@ export declare function useShippingMethods(): {
         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>;
+    contextQuery: UseQueryReturnType<BrandedResponse<Operations, "readContext get /context">, Error>;
+    shippingMethodsQuery: UseQueryReturnType<BrandedResponse<Operations, "readShippingMethod post /shipping-method">, Error>;
     activeShippingMethod: ComputedRef<{
         active?: boolean;
         availabilityRule?: components["schemas"]["Rule"];
@@ -169,5 +125,5 @@ export declare function useShippingMethods(): {
             trackingUrl: string;
         };
         readonly updatedAt?: string;
-    }[] | undefined>;
+    }[]>;
 };

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

@@ -4,6 +4,7 @@ interface PaginationOptions {
     page?: MaybeRef<number>;
     total?: MaybeRef<number>;
     limit?: MaybeRef<number>;
+    totalCountMode?: MaybeRef<'exact' | 'next-pages' | 'none'>;
 }
 export declare function usePagination(opts?: PaginationOptions): {
     page: number;
@@ -12,10 +13,11 @@ export declare function usePagination(opts?: PaginationOptions): {
     pageCount: ComputedRef<number>;
     isLastPage: ComputedRef<boolean>;
     isFirstPage: ComputedRef<boolean>;
-    usePaginationSync: (data: MaybeRef<Schemas["EntitySearchResult"]>) => void;
+    usePaginationSync: (data: MaybeRef<Schemas["EntitySearchResult"] | undefined>) => void;
     queryOptions: ComputedRef<{
         p: number;
         limit: number | undefined;
+        'total-count-mode': "none" | "exact" | "next-pages";
     }>;
 };
 export {};

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

@@ -1,2 +1,3 @@
-import { ComputedRef } from 'vue';
-export declare function useIsLoggedIn(): ComputedRef<boolean>;
+import { MaybeRef, ComputedRef } from 'vue';
+import { Schemas } from '../../../api-types/storeApiTypes.d.ts';
+export declare function useIsLoggedIn(context: MaybeRef<Schemas['SalesChannelContext'] | undefined>): ComputedRef<boolean>;

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

@@ -1,61 +1,11 @@
 import { Schemas } from '../../query/types';
 import { ComputedRef } from 'vue';
+import { BrandedResponse } from '@teamnovu/kit-shopware-api-client';
+import { Operations } from '../..';
 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>;
+    user: ComputedRef< BrandedResponse<Operations, "readCustomer post /account/customer"> | undefined>;
     isLoggedIn: ComputedRef<boolean>;
     isCustomerSession: ComputedRef<boolean>;
     isGuestSession: ComputedRef<boolean>;
@@ -111,57 +61,5 @@ export declare function useUser(criteria?: Schemas['Criteria']): {
         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>;
+    customerQuery: UseQueryReturnType<BrandedResponse<Operations, "readCustomer post /account/customer">, Error>;
 };