@teamnovu/kit-shopware-composables 0.0.5 → 0.0.7

package/src/query/customer/useChangeEmailMutation.ts

@@ -1,16 +1,17 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
 import { unref } from 'vue'
-import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
 import { customerKeys } from '../../keys'
 import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 
 const changeEmailOperation = 'changeEmail post /account/change-email' satisfies OperationKey
 
 export function useChangeEmailMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof changeEmailOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof changeEmailOperation>
   >,
 ) {
@@ -22,11 +23,10 @@ export function useChangeEmailMutation(
     mutationFn: async (options: OperationOptions<typeof changeEmailOperation>) => {
       return client.query(changeEmailOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
-      queryClient.invalidateQueries({ queryKey: customerKeys.get() })
+    onSuccess: async (data, variables, context) => {
+      await queryClient.invalidateQueries({ queryKey: customerKeys.all() })
 
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }
-

package/src/query/customer/useChangeProfileMutation.ts

@@ -1,16 +1,17 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
 import { unref } from 'vue'
-import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
 import { customerKeys } from '../../keys'
 import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 
 const changeProfileOperation = 'changeProfile post /account/change-profile' satisfies OperationKey
 
 export function useChangeProfileMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof changeProfileOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof changeProfileOperation>
   >,
 ) {
@@ -22,11 +23,10 @@ export function useChangeProfileMutation(
     mutationFn: async (options: OperationOptions<typeof changeProfileOperation>) => {
       return client.query(changeProfileOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
-      queryClient.invalidateQueries({ queryKey: customerKeys.get() })
+    onSuccess: async (data, variables, context) => {
+      await queryClient.invalidateQueries({ queryKey: customerKeys.all() })
 
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }
-

package/src/query/customer/useLoginCustomerMutation.ts

@@ -1,15 +1,16 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
 import { unref } from 'vue'
-import type { OperationBody, OperationKey, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
-import { contextKeys, cartKeys, customerKeys } from '../../keys'
+import { cartKeys, contextKeys, customerKeys } from '../../keys'
+import type { OperationBody, OperationKey, OperationResponse } from '../types/query'
 
 const loginCustomerOperation = 'loginCustomer post /account/login' satisfies OperationKey
 
 export function useLoginCustomerMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof loginCustomerOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationBody<typeof loginCustomerOperation>
   >,
 ) {
@@ -31,12 +32,14 @@ export function useLoginCustomerMutation(
 
       return response.json()
     },
-    onSuccess: (newCustomer, variables, context) => {
-      queryClient.invalidateQueries({ queryKey: contextKeys.all() })
-      queryClient.invalidateQueries({ queryKey: cartKeys.get() })
-      queryClient.invalidateQueries({ queryKey: customerKeys.get() })
+    onSuccess: async (newCustomer, variables, context) => {
+      await Promise.all([
+        queryClient.removeQueries({ queryKey: contextKeys.all() }),
+        queryClient.invalidateQueries({ queryKey: cartKeys.get() }),
+        queryClient.invalidateQueries({ queryKey: customerKeys.all() }),
+      ])
 
-      unref(unref(mutationOptions)?.onSuccess)?.(newCustomer, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(newCustomer, variables, context)
     },
   })
 }

package/src/query/customer/useLogoutCustomerMutation.ts

@@ -1,8 +1,9 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
 import { unref } from 'vue'
 import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
-import { customerKeys } from '../../keys'
+import { cartKeys, contextKeys, customerKeys } from '../../keys'
 import { unrefOptions } from '../../util/unrefOptions'
 
 const logoutOperation = 'logoutCustomer post /account/logout' satisfies OperationKey
@@ -10,7 +11,7 @@ const logoutOperation = 'logoutCustomer post /account/logout' satisfies Operatio
 export function useLogoutCustomerMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof logoutOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof logoutOperation>
   >,
 ) {
@@ -22,11 +23,14 @@ export function useLogoutCustomerMutation(
     mutationFn: async (options?: OperationOptions<typeof logoutOperation>) => {
       return client.query(logoutOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
-      queryClient.removeQueries({ queryKey: customerKeys.get() })
+    onSuccess: async (data, variables, context) => {
+      await Promise.all([
+        queryClient.removeQueries({ queryKey: contextKeys.all() }),
+        queryClient.invalidateQueries({ queryKey: cartKeys.get() }),
+        queryClient.invalidateQueries({ queryKey: customerKeys.all() }),
+      ])
 
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }
-

package/src/query/customer/useReadCustomerQuery.ts

@@ -3,6 +3,7 @@ import { useShopwareQueryClient } from '../../inject'
 import { customerKeys } from '../../keys'
 import { unrefOptions } from '../../util'
 import type { OperationKey, OperationOptions } from '../types/query'
+import { computed } from 'vue'
 
 const readCustomer = 'readCustomer post /account/customer' satisfies OperationKey
 
@@ -10,7 +11,7 @@ export function useReadCustomerQueryOptions(
   options?: OperationOptions<typeof readCustomer>,
 ) {
   const client = useShopwareQueryClient()
-  const queryKey = customerKeys.get()
+  const queryKey = customerKeys.detail(computed(() => unrefOptions(options).body ?? {}))
 
   return queryOptions({
     queryKey,

package/src/query/customer/useRegisterCustomerMutation.ts

@@ -1,16 +1,17 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
 import { unref } from 'vue'
-import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
 import { customerKeys } from '../../keys'
 import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 
 const registerOperation = 'register post /account/register' satisfies OperationKey
 
 export function useRegisterCustomerMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof registerOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof registerOperation>
   >,
 ) {
@@ -22,11 +23,10 @@ export function useRegisterCustomerMutation(
     mutationFn: async (options: OperationOptions<typeof registerOperation>) => {
       return client.query(registerOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
-      queryClient.invalidateQueries({ queryKey: customerKeys.get() })
+    onSuccess: async (data, variables, context) => {
+      await queryClient.invalidateQueries({ queryKey: customerKeys.all() })
 
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }
-

package/src/query/index.ts

@@ -2,9 +2,13 @@ export * from './address'
 export * from './cart'
 export * from './checkout'
 export * from './context'
+export * from './country'
 export * from './customer'
+export * from './navigation'
 export * from './order'
 export * from './payment'
 export * from './products'
+export * from './salutation'
+export * from './seoUrl'
 export * from './shipping'
 export * from './types'

package/src/query/navigation/index.ts

@@ -0,0 +1 @@
+export * from './useReadNavigationQuery'

package/src/query/navigation/useReadNavigationQuery.ts

@@ -0,0 +1,43 @@
+import { queryOptions, useQuery } from '@tanstack/vue-query'
+import { unref, type MaybeRef } from 'vue'
+import { useShopwareQueryClient } from '../../inject'
+import { navigationKeys } from '../../keys'
+import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions } from '../types/query'
+
+const readNavigationOperation = 'readNavigation post /navigation/{activeId}/{rootId}' satisfies OperationKey
+
+export const useReadNavigationQueryOptions = function useReadNavigationQueryOptions(
+  activeId: MaybeRef<string>,
+  rootId: MaybeRef<string>,
+  options?: OperationOptions<typeof readNavigationOperation>,
+) {
+  const client = useShopwareQueryClient()
+  const queryKey = navigationKeys.detail(activeId, rootId, options)
+
+  return queryOptions({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      const unrefdActiveId = unref(activeId)
+      const unrefdRootId = unref(rootId)
+      const unrefedOptions = unrefOptions(options)
+
+      return client.query(readNavigationOperation, {
+        ...unrefedOptions,
+        params: {
+          activeId: unrefdActiveId,
+          rootId: unrefdRootId,
+        },
+        signal,
+      })
+    },
+  })
+}
+
+export function useReadNavigationQuery(
+  activeId: MaybeRef<string>,
+  rootId: MaybeRef<string>,
+  options?: OperationOptions<typeof readNavigationOperation>,
+) {
+  return useQuery(useReadNavigationQueryOptions(activeId, rootId, options))
+}

package/src/query/order/useReadOrderQuery.ts

@@ -21,7 +21,6 @@ export function useReadOrderQueryOptions(
         signal,
       })
     },
-    enabled: !!options,
   })
 }
 
@@ -30,4 +29,3 @@ export function useReadOrderQuery(
 ) {
   return useQuery(useReadOrderQueryOptions(options))
 }
-

package/src/query/payment/useHandlePaymentMutation.ts

@@ -1,4 +1,5 @@
-import { useMutation, UseMutationOptions } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
+import { useMutation, type UseMutationOptions } from '@tanstack/vue-query'
 import { unref } from 'vue'
 import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
@@ -9,7 +10,7 @@ const handlePaymentOperation = 'handlePaymentMethod post /handle-payment' satisf
 export function useHandlePaymentMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof handlePaymentOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof handlePaymentOperation>
   >,
 ) {
@@ -20,8 +21,8 @@ export function useHandlePaymentMutation(
     mutationFn: async (options: OperationOptions<typeof handlePaymentOperation>) => {
       return client.query(handlePaymentOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+    onSuccess: async (data, variables, context) => {
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }

package/src/query/payment/useOrderSetPaymentMutation.ts

@@ -1,4 +1,5 @@
-import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import { ShopwareApiError } from '@teamnovu/kit-shopware-api-client'
+import { useMutation, type UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
 import { unref } from 'vue'
 import type { OperationKey, OperationOptions, OperationResponse } from '../types/query'
 import { useShopwareQueryClient } from '../../inject'
@@ -10,7 +11,7 @@ const orderSetPaymentOperation = 'orderSetPayment post /order/payment' satisfies
 export function useOrderSetPaymentMutation(
   mutationOptions?: UseMutationOptions<
     OperationResponse<typeof orderSetPaymentOperation>,
-    unknown,
+    ShopwareApiError | Error,
     OperationOptions<typeof orderSetPaymentOperation>
   >,
 ) {
@@ -22,11 +23,11 @@ export function useOrderSetPaymentMutation(
     mutationFn: async (options: OperationOptions<typeof orderSetPaymentOperation>) => {
       return client.query(orderSetPaymentOperation, unrefOptions(options))
     },
-    onSuccess: (data, variables, context) => {
+    onSuccess: async (data, variables, context) => {
       // Invalidate order queries to refetch updated payment information
-      queryClient.invalidateQueries({ queryKey: orderKeys.all() })
+      await queryClient.invalidateQueries({ queryKey: orderKeys.all() })
 
-      unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
+      await unref(unref(mutationOptions)?.onSuccess)?.(data, variables, context)
     },
   })
 }

package/src/query/salutation/index.ts

@@ -0,0 +1 @@
+export * from './useReadSalutationQuery'

package/src/query/salutation/useReadSalutationQuery.ts

@@ -0,0 +1,31 @@
+import { queryOptions, useQuery } from '@tanstack/vue-query'
+import { useShopwareQueryClient } from '../../inject'
+import { salutationKeys } from '../../keys'
+import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions } from '../types/query'
+
+const readSalutationOperation = 'readSalutation post /salutation' satisfies OperationKey
+
+export const useReadSalutationQueryOptions = function useReadSalutationQueryOptions(
+  options?: OperationOptions<typeof readSalutationOperation>,
+) {
+  const client = useShopwareQueryClient()
+  const queryKey = salutationKeys.list(options)
+
+  return queryOptions({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      const unrefedOptions = unrefOptions(options)
+
+      return client.query(readSalutationOperation, {
+        ...unrefedOptions,
+        signal,
+      })
+    },
+  })
+}
+
+export function useReadSalutationQuery(options?: OperationOptions<typeof readSalutationOperation>) {
+  return useQuery(useReadSalutationQueryOptions(options))
+}
+

package/src/query/seoUrl/index.ts

@@ -0,0 +1 @@
+export * from './useReadSeoUrlQuery'

package/src/query/seoUrl/useReadSeoUrlQuery.ts

@@ -0,0 +1,31 @@
+import { queryOptions, useQuery } from '@tanstack/vue-query'
+import { useShopwareQueryClient } from '../../inject'
+import { seoUrlKeys } from '../../keys'
+import { unrefOptions } from '../../util/unrefOptions'
+import type { OperationKey, OperationOptions } from '../types/query'
+
+const readSeoUrlOperation = 'readSeoUrl post /seo-url' satisfies OperationKey
+
+export const useReadSeoUrlQueryOptions = function useReadSeoUrlQueryOptions(
+  options?: OperationOptions<typeof readSeoUrlOperation>,
+) {
+  const client = useShopwareQueryClient()
+  const queryKey = seoUrlKeys.list(options)
+
+  return queryOptions({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      const unrefedOptions = unrefOptions(options)
+
+      return client.query(readSeoUrlOperation, {
+        ...unrefedOptions,
+        signal,
+      })
+    },
+  })
+}
+
+export function useReadSeoUrlQuery(options?: OperationOptions<typeof readSeoUrlOperation>) {
+  return useQuery(useReadSeoUrlQueryOptions(options))
+}
+

package/src/query/types/index.ts

@@ -1,2 +1,3 @@
 export * from './operations'
 export * from './query'
+export * from './util'

package/src/query/types/operations.ts

@@ -1,6 +1,6 @@
-import { operations, Schemas as OriginalSchemas } from '#store-types'
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+import type { operations as OriginalOperations, Schemas as OriginalSchemas } from '#store-types'
+
+export interface Operations extends ShopwareApi.Operations, OriginalOperations {}
+export interface Schemas extends ShopwareApi.Schemas, OriginalSchemas {}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface Operations extends operations {}
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface Schemas extends OriginalSchemas {}

package/src/query/types/query.ts

@@ -1,13 +1,11 @@
-import type { operations } from '#store-types'
 import type { QueryKey, UseQueryOptions } from '@tanstack/vue-query'
 import type {
   OperationProp,
   OperationOptions as RawOperationOptions,
 } from '@teamnovu/kit-shopware-api-client'
-import { MaybeRef, UnwrapRef } from 'vue'
-import { Operations } from './operations'
-
-export type PartialProps<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+import type { MaybeRef, UnwrapRef } from 'vue'
+import type { Operations } from './operations'
+import type { PartialProps } from './util'
 
 export type ShallowMaybeRefs<T> = {
   [K in keyof T]: MaybeRef<T[K]>
@@ -17,7 +15,7 @@ export type ShallowUnwrapRefs<T> = {
   [K in keyof T]: UnwrapRef<T[K]>
 }
 
-export type OperationKey = keyof operations
+export type OperationKey = keyof Operations
 export type OperationBody<K extends OperationKey> =
   OperationProp<Operations, K, 'body'>
 export type OperationResponse<K extends OperationKey> =

package/src/query/types/util.ts

@@ -0,0 +1,19 @@
+type DeepOverride<T, U> = {
+  [K in keyof U]: K extends keyof T
+    ? U[K] extends infer UK
+      ? T[K] extends infer TK
+        ? TK extends Record<string, unknown>
+          ? UK extends Record<string, unknown>
+            ? Override<T[K], U[K]>
+            : U[K]
+          : U[K]
+        : U[K]
+      : never
+    : never
+}
+
+export type Override<T, U> = T extends Record<string, unknown>
+  ? DeepOverride<T, U> & Omit<T, keyof U>
+  : U
+
+export type PartialProps<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>

package/src/util/unrefOptions.ts

@@ -1,7 +1,7 @@
-import { unref, UnwrapRef } from 'vue'
-import { OperationOptions as RawOperationOptions } from '@teamnovu/kit-shopware-api-client'
-import { OperationOptions, PartialProps } from '../query/types/query'
-import { Operations } from '../query/types'
+import { unref, type UnwrapRef } from 'vue'
+import type { OperationOptions as RawOperationOptions } from '@teamnovu/kit-shopware-api-client'
+import type { OperationOptions } from '../query/types/query'
+import type { Operations, PartialProps } from '../query/types'
 
 export function unrefOptions<
   K extends keyof Operations,

package/src/util/useOptimistic.ts

@@ -1,4 +1,5 @@
-import { MutationOptions, QueryKey, UseMutationOptions, useQueryClient } from '@tanstack/vue-query'
+import type { MutationOptions, QueryKey, UseMutationOptions } from '@tanstack/vue-query'
+import { useQueryClient } from '@tanstack/vue-query'
 import { unref } from 'vue'
 
 // https://tanstack.com/query/latest/docs/framework/vue/guides/optimistic-updates#via-the-cache

package/tsconfig.json

@@ -2,14 +2,16 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "dist",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
     "types": [
       "vue",
       "vite/client",
-      "vitest/globals"
+      "vitest/globals",
     ],
     "paths": {
       "#types": [
-        "./src/types.d.ts"
+        "./src/types/operations.d.ts"
       ],
       "#store-types": [
         "./api-types/storeApiTypes.d.ts"

package/vite.config.js

@@ -1,7 +1,7 @@
 import vue from '@vitejs/plugin-vue'
 import { resolve } from 'path'
 import { defineConfig } from 'vite'
-import dts from 'vite-plugin-dts'
+import dts from 'unplugin-dts/vite'
 import pkg from './package.json'
 
 export default defineConfig({
@@ -9,6 +9,11 @@ export default defineConfig({
     vue(),
     dts({
       staticImport: true,
+      copyDtsFiles: true,
+      compilerOptions: {
+        declaration: true,
+        emitDeclarationOnly: true,
+      },
     }),
   ],
   build: {

package/dist/query/checkout/useCheckout.d.ts

@@ -1 +0,0 @@
-export declare const useCheckout: () => void;

package/src/query/checkout/useCheckout.ts

@@ -1,2 +0,0 @@
-export const useCheckout = () => {
-}