feat(utils): add @suspensive/utils (#1110)

# Overview  ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md) 2. I added documents and tests.
toss · Jul 19, 2024 · 418b9b4 · 418b9b4
1 parent 6d109da
commit 418b9b4
Show file tree

Hide file tree

Showing 82 changed files with 348 additions and 407 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -2,7 +2,15 @@
   "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
   "changelog": ["@changesets/changelog-github", { "repo": "toss/suspensive" }],
   "commit": false,
-  "fixed": [["@suspensive/react", "@suspensive/react-query", "@suspensive/react-query-4", "@suspensive/react-query-5"]],
+  "fixed": [
+    [
+      "@suspensive/utils",
+      "@suspensive/react",
+      "@suspensive/react-query",
+      "@suspensive/react-query-4",
+      "@suspensive/react-query-5"
+    ]
+  ],
   "ignore": ["@suspensive/next-streaming-react-query", "@suspensive/visualization", "@suspensive/suspensive.org"],
   "linked": [],
   "access": "restricted",

diff --git a/.changeset/strange-buttons-retire.md b/.changeset/strange-buttons-retire.md
@@ -0,0 +1,5 @@
+---
+"@suspensive/utils": patch
+---
+
+feat(utils): add @suspensive/utils
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -1,3 +1,5 @@
+"@suspensive/utils":
+  - "packages/utils/**/*"
 "@suspensive/react":
   - "packages/react/**/*"
 "@suspensive/react-query":

diff --git a/codecov.yml b/codecov.yml
@@ -20,6 +20,10 @@ ignore:
 
 component_management:
   individual_components:
+    - component_id: utils
+      name: '@suspensive/utils'
+      paths:
+        - packages/utils/**
     - component_id: react
       name: '@suspensive/react'
       paths:

diff --git a/configs/test-utils/src/index.tsx b/configs/test-utils/src/index.tsx
diff --git a/packages/cache/package.json b/packages/cache/package.json
@@ -49,10 +49,12 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/react": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@types/react": "^18.3.3",

diff --git a/packages/cache/src/Cache.spec.tsx b/packages/cache/src/Cache.spec.tsx
@@ -1,5 +1,5 @@
 import { Suspense } from '@suspensive/react'
-import { TEXT } from '@suspensive/test-utils'
+import { TEXT } from '@suspensive/utils'
 import { render, screen } from '@testing-library/react'
 import { Cache } from './Cache'
 import { CacheStore } from './CacheStore'

diff --git a/packages/cache/src/CacheStore.spec.tsx b/packages/cache/src/CacheStore.spec.tsx
@@ -1,4 +1,4 @@
-import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/test-utils'
+import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/utils'
 import { render, screen, waitFor } from '@testing-library/react'
 import ms from 'ms'
 import { Suspense } from 'react'

diff --git a/packages/cache/src/cacheOptions.spec.tsx b/packages/cache/src/cacheOptions.spec.tsx
@@ -1,4 +1,4 @@
-import { FALLBACK, TEXT } from '@suspensive/test-utils'
+import { FALLBACK, TEXT } from '@suspensive/utils'
 import { render, screen } from '@testing-library/react'
 import { Suspense } from 'react'
 import { Cache } from './Cache'

diff --git a/packages/cache/src/useCache.spec.tsx b/packages/cache/src/useCache.spec.tsx
@@ -1,5 +1,5 @@
 import { ErrorBoundary, Suspense } from '@suspensive/react'
-import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/test-utils'
+import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/utils'
 import { render, screen, waitFor } from '@testing-library/react'
 import ms from 'ms'
 import { cacheOptions } from './cacheOptions'

diff --git a/packages/jotai/package.json b/packages/jotai/package.json
@@ -49,6 +49,9 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",

diff --git a/packages/react-await/package.json b/packages/react-await/package.json
@@ -49,10 +49,12 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/react": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@types/react": "^18.3.3",

diff --git a/packages/react-await/src/Await.spec.tsx b/packages/react-await/src/Await.spec.tsx
@@ -1,5 +1,5 @@
 import { Suspense } from '@suspensive/react'
-import { TEXT } from '@suspensive/test-utils'
+import { TEXT } from '@suspensive/utils'
 import { render, screen } from '@testing-library/react'
 import { Await } from './Await'
 

diff --git a/packages/react-await/src/AwaitClient.spec.tsx b/packages/react-await/src/AwaitClient.spec.tsx
@@ -1,4 +1,4 @@
-import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/test-utils'
+import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/utils'
 import { render, screen, waitFor } from '@testing-library/react'
 import ms from 'ms'
 import { Suspense } from 'react'

diff --git a/packages/react-await/src/awaitOptions.spec.tsx b/packages/react-await/src/awaitOptions.spec.tsx
@@ -1,4 +1,4 @@
-import { FALLBACK, TEXT } from '@suspensive/test-utils'
+import { FALLBACK, TEXT } from '@suspensive/utils'
 import { render, screen } from '@testing-library/react'
 import { Suspense } from 'react'
 import { Await } from './Await'

diff --git a/packages/react-await/src/useAwait.spec.tsx b/packages/react-await/src/useAwait.spec.tsx
@@ -1,5 +1,5 @@
 import { ErrorBoundary, Suspense } from '@suspensive/react'
-import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/test-utils'
+import { ERROR_MESSAGE, FALLBACK, TEXT, sleep } from '@suspensive/utils'
 import { render, screen, waitFor } from '@testing-library/react'
 import ms from 'ms'
 import { awaitClient } from './AwaitClient'

diff --git a/packages/react-image/package.json b/packages/react-image/package.json
@@ -49,9 +49,11 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@types/react": "^18.3.3",

diff --git a/packages/react-query-4/package.json b/packages/react-query-4/package.json
@@ -50,10 +50,12 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/react": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@tanstack/react-query": "^4.36.1",

diff --git a/packages/react-query-4/src/SuspenseInfiniteQuery.test-d.tsx b/packages/react-query-4/src/SuspenseInfiniteQuery.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { InfiniteData } from '@tanstack/react-query'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'

diff --git a/packages/react-query-4/src/SuspenseQueries.test-d.tsx b/packages/react-query-4/src/SuspenseQueries.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'
 import { queryOptions } from './queryOptions'

diff --git a/packages/react-query-4/src/SuspenseQuery.test-d.tsx b/packages/react-query-4/src/SuspenseQuery.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'
 import { queryOptions } from './queryOptions'

diff --git a/packages/react-query-4/src/infiniteQueryOptions.test-d.tsx b/packages/react-query-4/src/infiniteQueryOptions.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryKey } from '@suspensive/test-utils'
+import { queryKey } from '@suspensive/utils'
 import { type InfiniteData, type UseInfiniteQueryResult, useInfiniteQuery, useQueryClient } from '@tanstack/react-query'
 import { describe, expectTypeOf, it } from 'vitest'
 import { infiniteQueryOptions } from './infiniteQueryOptions'

diff --git a/packages/react-query-4/src/infiniteQueryOptions.ts b/packages/react-query-4/src/infiniteQueryOptions.ts
@@ -1,5 +1,5 @@
+import type { OmitKeyof, RequiredKeyof } from '@suspensive/utils'
 import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'
-import type { OmitKeyof, RequiredKeyof } from './utility-types'
 
 type SelectedInfiniteOptions<
   TQueryFnData,

diff --git a/packages/react-query-4/src/queryOptions.test-d.tsx b/packages/react-query-4/src/queryOptions.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryKey } from '@suspensive/test-utils'
+import { queryKey } from '@suspensive/utils'
 import { type UseQueryResult, useQueries, useQuery, useQueryClient } from '@tanstack/react-query'
 import { describe, expectTypeOf, it } from 'vitest'
 import { queryOptions } from './queryOptions'

diff --git a/packages/react-query-4/src/queryOptions.ts b/packages/react-query-4/src/queryOptions.ts
@@ -1,5 +1,5 @@
+import type { OmitKeyof, RequiredKeyof } from '@suspensive/utils'
 import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'
-import type { OmitKeyof, RequiredKeyof } from './utility-types'
 
 type SelectedQueryOptions<
   TQueryFnData = unknown,

diff --git a/packages/react-query-4/src/useSuspenseInfiniteQuery.test-d.ts b/packages/react-query-4/src/useSuspenseInfiniteQuery.test-d.ts
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { InfiniteData } from '@tanstack/react-query'
 import { infiniteQueryOptions } from './infiniteQueryOptions'
 import { type UseSuspenseInfiniteQueryResult, useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery'

diff --git a/packages/react-query-4/src/useSuspenseInfiniteQuery.ts b/packages/react-query-4/src/useSuspenseInfiniteQuery.ts
@@ -1,11 +1,11 @@
+import type { OmitKeyof } from '@suspensive/utils'
 import {
   type InfiniteData,
   type QueryKey,
   type UseInfiniteQueryOptions,
   type UseInfiniteQueryResult,
   useInfiniteQuery,
 } from '@tanstack/react-query'
-import type { OmitKeyof } from './utility-types'
 
 export interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown>
   extends OmitKeyof<

diff --git a/packages/react-query-4/src/useSuspenseQueries.test-d.ts b/packages/react-query-4/src/useSuspenseQueries.test-d.ts
@@ -1,4 +1,4 @@
-import { queryFn, queryKey, select } from '@suspensive/test-utils'
+import { queryFn, queryKey, select } from '@suspensive/utils'
 import { describe, expectTypeOf, it } from 'vitest'
 import { queryOptions } from './queryOptions'
 import { useSuspenseQueries } from './useSuspenseQueries'

diff --git a/packages/react-query-4/src/useSuspenseQuery.test-d.ts b/packages/react-query-4/src/useSuspenseQuery.test-d.ts
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import { describe, expectTypeOf, it } from 'vitest'
 import { queryOptions } from './queryOptions'
 import { type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'

diff --git a/packages/react-query-4/src/useSuspenseQuery.ts b/packages/react-query-4/src/useSuspenseQuery.ts
@@ -1,5 +1,5 @@
+import type { OmitKeyof } from '@suspensive/utils'
 import { type QueryKey, type UseQueryOptions, type UseQueryResult, useQuery } from '@tanstack/react-query'
-import type { OmitKeyof } from './utility-types'
 
 export interface UseSuspenseQueryResult<TData = unknown, TError = unknown>
   extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {

diff --git a/packages/react-query-4/src/utility-types/index.ts b/packages/react-query-4/src/utility-types/index.ts
diff --git a/packages/react-query-5/package.json b/packages/react-query-5/package.json
@@ -50,10 +50,12 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/react": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@tanstack/react-query": "^5.50.1",

diff --git a/packages/react-query-5/src/SuspenseInfiniteQuery.test-d.tsx b/packages/react-query-5/src/SuspenseInfiniteQuery.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { InfiniteData, UseSuspenseInfiniteQueryResult } from '@tanstack/react-query'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'

diff --git a/packages/react-query-5/src/SuspenseQueries.test-d.tsx b/packages/react-query-5/src/SuspenseQueries.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { UseSuspenseQueryResult } from '@tanstack/react-query'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'

diff --git a/packages/react-query-5/src/SuspenseQuery.test-d.tsx b/packages/react-query-5/src/SuspenseQuery.test-d.tsx
@@ -1,4 +1,4 @@
-import { queryFn, queryKey } from '@suspensive/test-utils'
+import { queryFn, queryKey } from '@suspensive/utils'
 import type { UseSuspenseQueryResult } from '@tanstack/react-query'
 import type { ReactNode } from 'react'
 import { describe, expectTypeOf, it } from 'vitest'

diff --git a/packages/react-query/package.json b/packages/react-query/package.json
@@ -59,13 +59,13 @@
     "@commander-js/extra-typings": "^12.1.0",
     "@suspensive/react-query-4": "workspace:^2.8.0",
     "@suspensive/react-query-5": "workspace:^2.8.0",
+    "@suspensive/utils": "workspace:*",
     "cli-table3": "^0.6.5",
     "commander": "^12.1.0"
   },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
     "@suspensive/react": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@tanstack/react-query": "^4.36.1",

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -50,9 +50,11 @@
     "dev": "tsup --watch",
     "prepack": "pnpm build"
   },
+  "dependencies": {
+    "@suspensive/utils": "workspace:*"
+  },
   "devDependencies": {
     "@suspensive/eslint-config": "workspace:*",
-    "@suspensive/test-utils": "workspace:*",
     "@suspensive/tsconfig": "workspace:*",
     "@suspensive/tsup": "workspace:*",
     "@types/react": "^18.3.3",

diff --git a/packages/react/src/Delay.spec.tsx b/packages/react/src/Delay.spec.tsx
@@ -1,4 +1,4 @@
-import { CustomError, TEXT } from '@suspensive/test-utils'
+import { CustomError, TEXT } from '@suspensive/utils'
 import { render, screen, waitFor } from '@testing-library/react'
 import ms from 'ms'
 import { Delay } from './Delay'

diff --git a/packages/react/src/Delay.tsx b/packages/react/src/Delay.tsx
@@ -1,6 +1,6 @@
+import { useTimeout } from '@suspensive/utils'
 import { type PropsWithChildren, type ReactNode, useContext, useState } from 'react'
 import { DelayDefaultPropsContext } from './contexts'
-import { useTimeout } from './hooks'
 import { Message_Delay_ms_prop_should_be_greater_than_or_equal_to_0, SuspensiveError } from './models/SuspensiveError'
 
 export interface DelayProps extends PropsWithChildren {