@codeleap/query 5.8.3 → 5.8.5

package/src/tests/setup.ts

@@ -0,0 +1,119 @@
+import { afterEach, beforeEach } from 'bun:test'
+import { QueryClient } from '@tanstack/react-query'
+import { cleanup } from '@testing-library/react'
+
+export interface TestUser {
+  id: string
+  name: string
+  email: string
+  status: 'active' | 'inactive'
+  createdAt: string
+}
+
+export interface TestUserFilters {
+  status?: 'active' | 'inactive'
+  search?: string
+}
+
+export const createTestQueryClient = () => {
+  return new QueryClient({
+    defaultOptions: {
+      queries: {
+        retry: false,
+        gcTime: 0,
+      },
+      mutations: {
+        retry: false,
+      },
+    },
+  })
+}
+
+export const createMockUser = (overrides: Partial<TestUser> = {}): TestUser => ({
+  id: `user-${Date.now()}-${Math.random()}`,
+  name: 'John Doe',
+  email: 'john@example.com',
+  status: 'active',
+  createdAt: new Date().toISOString(),
+  ...overrides,
+})
+
+export const createMockUsers = (count: number): TestUser[] => {
+  return Array.from({ length: count }, (_, i) => createMockUser({
+    id: `user-${i + 1}`,
+    name: `User ${i + 1}`,
+    email: `user${i + 1}@example.com`,
+  }))
+}
+
+export const createMockApiFunctions = () => {
+  const users: TestUser[] = []
+
+  return {
+    listFn: async (limit: number, offset: number, filters?: TestUserFilters) => {
+      let filteredUsers = [...users]
+
+      if (filters?.status) {
+        filteredUsers = filteredUsers.filter(user => user.status === filters.status)
+      }
+
+      if (filters?.search) {
+        filteredUsers = filteredUsers.filter(user =>
+          user.name.toLowerCase().includes(filters.search!.toLowerCase()) ||
+          user.email.toLowerCase().includes(filters.search!.toLowerCase())
+        )
+      }
+
+      return filteredUsers.slice(offset, offset + limit)
+    },
+
+    retrieveFn: async (id: string) => {
+      const user = users.find(u => u.id === id)
+      if (!user) throw new Error('User not found')
+      return user
+    },
+
+    createFn: async (data: Partial<TestUser>) => {
+      const newUser: TestUser = {
+        id: `user-${users?.length + 1}`,
+        name: data.name || 'New User',
+        email: data.email || 'new@example.com',
+        status: data.status || 'active',
+        createdAt: new Date().toISOString(),
+      }
+      users.push(newUser)
+      return newUser
+    },
+
+    updateFn: async (data: Partial<TestUser>) => {
+      const userIndex = users.findIndex(u => u.id === data.id)
+      if (userIndex === -1) throw new Error('User not found')
+
+      users[userIndex] = { ...users[userIndex], ...data }
+      return users[userIndex]
+    },
+
+    deleteFn: async (id: string) => {
+      const userIndex = users.findIndex(u => u.id === id)
+      if (userIndex === -1) throw new Error('User not found')
+
+      users.splice(userIndex, 1)
+      return id
+    },
+
+    getUsersArray: () => [...users],
+    addUser: (user: TestUser) => users.push(user),
+    clearUsers: () => users.splice(0, users.length),
+    setUsers: (newUsers: TestUser[]) => {
+      users.splice(0, users.length, ...newUsers)
+    }
+  }
+}
+
+beforeEach(() => { })
+
+afterEach(() => {
+  cleanup()
+})
+
+export const waitFor = (ms: number) => new Promise(resolve => setTimeout(resolve, ms))

package/src/types/core.ts

@@ -0,0 +1,33 @@
+import { UseInfiniteQueryResult, useQueryClient } from '@tanstack/react-query'
+
+export type QueryItem = {
+  id: string | number
+}
+
+export type PageParam = number
+
+export type ListPaginationResponse<T extends QueryItem> = T[]
+
+export type QueryManagerOptions<T extends QueryItem, F> = {
+  name: string
+
+  queryClient: ReturnType<typeof useQueryClient>
+
+  listFn?: (limit: number, offset: number, filters: F) => Promise<ListPaginationResponse<T>>
+
+  listLimit?: number
+
+  useListEffect?: (listQuery: UseInfiniteQueryResult<{
+    pageParams: number[]
+    pages: ListPaginationResponse<T>[]
+    allItems: T[]
+  }, Error>) => void
+
+  retrieveFn?: (id: T['id']) => Promise<T>
+
+  createFn?: (data: Partial<T>) => Promise<T>
+
+  updateFn?: (data: Partial<T>) => Promise<T>
+
+  deleteFn?: (id: T['id']) => Promise<T['id']>
+}

package/src/types/create.ts

@@ -0,0 +1,16 @@
+import { UseMutationOptions } from '@tanstack/react-query'
+import { QueryItem } from './core'
+import { RemovedItemMap } from './utility'
+
+export type CreateMutationCtx = {
+  tempId?: QueryItem['id']
+}
+
+export type CreateMutationOptions<T extends QueryItem, F> = Omit<
+  UseMutationOptions<T, Error, Partial<T>, CreateMutationCtx>,
+  'mutationKey' | 'mutationFn'
+> & {
+  optimistic?: boolean
+  listFilters?: F
+  appendTo?: RemovedItemMap | 'start' | 'end'
+}

package/src/types/delete.ts

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from '@tanstack/react-query'
+import { QueryItem } from './core'
+import { RemovedItemMap } from './utility'
+
+export type DeleteMutationCtx<T> = {
+  previousItem: T | undefined
+  removedAt: RemovedItemMap
+}
+
+export type DeleteMutationOptions<T extends QueryItem, F> = Omit<
+  UseMutationOptions<unknown, Error, T['id'], DeleteMutationCtx<T>>,
+  'mutationKey' | 'mutationFn'
+> & {
+  optimistic?: boolean
+}

package/src/types/index.ts

@@ -0,0 +1,7 @@
+export * from './core'
+export * from './list'
+export * from './utility'
+export * from './retrieve'
+export * from './create'
+export * from './update'
+export * from './delete'

package/src/types/list.ts

@@ -0,0 +1,24 @@
+import { QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'
+import { ListPaginationResponse, PageParam, QueryItem } from './core'
+
+export type ListSelector<T extends QueryItem> = {
+  pageParams: PageParam[]
+  pages: ListPaginationResponse<T>[]
+  allItems: T[]
+}
+
+type InfiniteQueryOptions<T extends QueryItem> = UseInfiniteQueryOptions<
+  ListPaginationResponse<T>,
+  Error,
+  ListSelector<T>,
+  QueryKey,
+  PageParam
+>
+
+export type ListQueryOptions<T extends QueryItem, F> = Omit<
+  InfiniteQueryOptions<T>,
+  'queryKey' | 'queryFn' | 'initialPageParam' | 'getNextPageParam' | 'getPreviousPageParam' | 'select'
+> & {
+  limit?: number
+  filters?: F
+}

package/src/types/retrieve.ts

@@ -0,0 +1,7 @@
+import { QueryKey, UndefinedInitialDataOptions } from '@tanstack/react-query'
+import { QueryItem } from './core'
+
+export type RetrieveQueryOptions<T extends QueryItem> = Omit<
+  UndefinedInitialDataOptions<T, Error, T, QueryKey>,
+  'queryKey' | 'queryFn'
+>

package/src/types/update.ts

@@ -0,0 +1,14 @@
+import { UseMutationOptions } from '@tanstack/react-query'
+import { QueryItem } from './core'
+
+export type UpdateMutationCtx<T> = {
+  previousItem: T | undefined
+  optimisticItem: T | undefined
+}
+
+export type UpdateMutationOptions<T extends QueryItem, F> = Omit<
+  UseMutationOptions<T, Error, Partial<T>, UpdateMutationCtx<T>>,
+  'mutationKey' | 'mutationFn'
+> & {
+  optimistic?: boolean
+}

package/src/types/utility.ts

@@ -0,0 +1,22 @@
+import { QueryItem } from './core';
+import { QueryKey, useQueryClient } from '@tanstack/react-query'
+
+export type QueryClient = ReturnType<typeof useQueryClient>
+
+export type WithTempId<T extends QueryItem> = T & {
+  tempId?: QueryItem['id']
+}
+
+export type ItemPosition = {
+  pageIndex: number
+  itemIndex: number
+}
+
+export type RemovedItemMap = [QueryKey, ItemPosition][]
+
+export type PaginationResponse<T extends QueryItem> = {
+  count: number
+  next: string
+  previous: string
+  results: T[]
+}

package/src/utils/index.ts

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

package/src/utils/misc.ts

@@ -0,0 +1,43 @@
+function uuidV4() {
+  function randomHex() {
+    return Math.floor(Math.random() * 16).toString(16);
+  }
+
+  let uuid = ''
+
+  for (let i = 0; i < 8; i++) {
+    uuid += randomHex()
+  }
+
+  uuid += '-'
+
+  for (let i = 0; i < 4; i++) {
+    uuid += randomHex()
+  }
+
+  uuid += '-'
+
+  uuid += '4';
+  for (let i = 0; i < 3; i++) {
+    uuid += randomHex()
+  }
+  uuid += '-'
+
+  uuid += ['8', '9', 'a', 'b'][Math.floor(Math.random() * 4)];
+  for (let i = 0; i < 3; i++) {
+    uuid += randomHex()
+  }
+  uuid += '-'
+
+  for (let i = 0; i < 12; i++) {
+    uuid += randomHex()
+  }
+
+  return uuid
+}
+
+export const tempIdPrefix = 'temp-id'
+
+export const generateTempId = () => {
+  return tempIdPrefix + '-' + uuidV4()
+}