@teamnovu/kit-shopware-composables 0.0.7 → 0.0.8

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

@@ -1,12 +1,10 @@
 import { Schemas, components, GenericRecord } from '../../../api-types/storeApiTypes.d.ts';
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { OperationResponse, Operations } from '../..';
 import { ShopwareApiError, BrandedResponse } from '@teamnovu/kit-shopware-api-client';
-import { Operations } from '../..';
 import { ComputedRef } from 'vue';
 export declare function useCheckoutAddresses(): {
-    contextUpdateMutation: UseMutationReturnType<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    contextUpdateMutation: UseMutationReturnType<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,9 +13,7 @@ export declare function useCheckoutAddresses(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown, Omit< MutationObserverIdleResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown, Omit< MutationObserverIdleResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,9 +22,7 @@ export declare function useCheckoutAddresses(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,9 +31,7 @@ export declare function useCheckoutAddresses(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,9 +40,7 @@ export declare function useCheckoutAddresses(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;

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

@@ -1,180 +1,24 @@
 import { MaybeRef, ComputedRef } from 'vue';
-import { Schemas } from '../../query/types';
-import { components, GenericRecord } from '../../../api-types/storeApiTypes';
+import { BrandedSchema } from '../types/schema';
 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"][];
-        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>;
+export declare function useOrderDetails(orderId: MaybeRef<string>, criteria?: BrandedSchema<'Criteria'>): {
+    order: ComputedRef<BrandedSchema<"Order"> | 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>;
+    shippingAddress: ComputedRef<BrandedSchema<"OrderAddress"> | undefined>;
+    billingAddress: ComputedRef<BrandedSchema<"OrderAddress"> | 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>;
+    shippingMethod: ComputedRef<BrandedSchema<"ShippingMethod"> | undefined>;
+    paymentMethod: ComputedRef<BrandedSchema<"PaymentMethod"> | undefined>;
     paymentChangeable: ComputedRef<boolean>;
     orderQuery: UseQueryReturnType<BrandedResponse<Operations, "readOrder post /order">, Error>;
 };

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

@@ -1,5 +1,6 @@
 import { MaybeRef, ComputedRef } from 'vue';
-import { Schemas } from '../../query/types';
+import { Schemas } from '../../query/types/operations';
+import { BrandedSchema } from '../types/schema';
 import { GenericRecord, components } from '../../../api-types/storeApiTypes';
 export declare function useOrderPayment(order: MaybeRef<Schemas['Order'] | null | undefined>): {
     isAsynchronous: ComputedRef<any>;
@@ -34,40 +35,6 @@ export declare function useOrderPayment(order: MaybeRef<Schemas['Order'] | null
         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>;
+    state: ComputedRef<BrandedSchema<"StateMachineState"> | undefined>;
+    paymentMethod: ComputedRef<BrandedSchema<"PaymentMethod"> | undefined>;
 };

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

@@ -1,12 +1,10 @@
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { OperationResponse, Operations } from '../..';
 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;
-    }, Error | ShopwareApiError, {
+    contextUpdateMutation: UseMutationReturnType<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,9 +13,7 @@ export declare function usePaymentMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown, Omit< MutationObserverIdleResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown, Omit< MutationObserverIdleResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,9 +22,7 @@ export declare function usePaymentMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,9 +31,7 @@ export declare function usePaymentMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,9 +40,7 @@ export declare function usePaymentMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -86,9 +76,7 @@ export declare function usePaymentMethods(): {
         };
         readonly updatedAt?: string;
     } | undefined>;
-    setPaymentMethod: (paymentMethodId: string) => Promise<{
-        redirectUrl?: string;
-    }>;
+    setPaymentMethod: (paymentMethodId: string) => Promise< OperationResponse<"updateContext patch /context">>;
     isSaving: ComputedRef<boolean>;
     paymentMethods: ComputedRef<{
         active?: boolean;

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

@@ -1,12 +1,10 @@
 import { UseMutationReturnType, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverErrorResult, MutationObserverSuccessResult, UseQueryReturnType } from '@tanstack/vue-query';
+import { OperationResponse, Operations } from '../..';
 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;
-    }, Error | ShopwareApiError, {
+    contextUpdateMutation: UseMutationReturnType<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -15,9 +13,7 @@ export declare function useShippingMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown, Omit< MutationObserverIdleResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown, Omit< MutationObserverIdleResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -26,9 +22,7 @@ export declare function useShippingMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverLoadingResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -37,9 +31,7 @@ export declare function useShippingMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverErrorResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -48,9 +40,7 @@ export declare function useShippingMethods(): {
         paymentMethodId?: string;
         shippingAddressId?: string;
         shippingMethodId?: string;
-    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<{
-        redirectUrl?: string;
-    }, Error | ShopwareApiError, {
+    }, unknown>, "mutate" | "reset"> | Omit< MutationObserverSuccessResult<OperationResponse<"updateContext patch /context">, Error | ShopwareApiError, {
         billingAddressId?: string;
         countryId?: string;
         countryStateId?: string;
@@ -92,9 +82,7 @@ export declare function useShippingMethods(): {
         };
         readonly updatedAt?: string;
     } | undefined>;
-    setShippingMethod: (shippingMethodId: string) => Promise<{
-        redirectUrl?: string;
-    }>;
+    setShippingMethod: (shippingMethodId: string) => Promise< OperationResponse<"updateContext patch /context">>;
     isSaving: ComputedRef<boolean>;
     shippingMethods: ComputedRef<{
         active?: boolean;

package/dist/helpers/types/schema.d.ts

@@ -0,0 +1,5 @@
+import { Schemas } from '../../query/types/operations';
+export interface SchemaType<TKey> {
+    __key?: TKey;
+}
+export type BrandedSchema<SchemaKey extends (keyof Schemas) & string> = Schemas[SchemaKey] & SchemaType<SchemaKey>;