feat(client)!: rename success property to isSuccess in safe utility

For better readability and better compatible with `isDefined`

Author: dinwwwh

apps/content/docs/best-practices/no-throw-literal.md

@@ -34,12 +34,12 @@ Avoid using `any` or `unknown` for `throwableError` because doing so prevents th
 :::
 
 :::tip
-If you configure `throwableError` as `null | undefined | {}`, adjust your code to check the `success` property:
+If you configure `throwableError` as `null | undefined | {}`, adjust your code to check the `isSuccess` property instead of `error`:
 
 ```ts
-const { error, data, success } = await safe(client('input'))
+const { error, data, isSuccess } = await safe(client('input'))
 
-if (!success) {
+if (!isSuccess) {
   if (isDefinedError(error)) {
     // handle type-safe error
   }

packages/client/src/utils.test-d.ts

@@ -7,9 +7,9 @@ describe('safe', async () => {
   const client = {} as Client<ClientContext, string, number, Error | ORPCError<'BAD_GATEWAY', { val: string }>>
 
   it('tuple style', async () => {
-    const [error, data, isDefined, success] = await safe(client('123'))
+    const [error, data, isDefined, isSuccess] = await safe(client('123'))
 
-    if (error || !success) {
+    if (error || !isSuccess) {
       expectTypeOf(error).toEqualTypeOf<Error | ORPCError<'BAD_GATEWAY', { val: string }>>()
       expectTypeOf(data).toEqualTypeOf<undefined>()
       expectTypeOf(isDefined).toEqualTypeOf<boolean>()
@@ -33,9 +33,9 @@ describe('safe', async () => {
   })
 
   it('object style', async () => {
-    const { error, data, isDefined, success } = await safe(client('123'))
+    const { error, data, isDefined, isSuccess } = await safe(client('123'))
 
-    if (error || !success) {
+    if (error || !isSuccess) {
       expectTypeOf(error).toEqualTypeOf<Error | ORPCError<'BAD_GATEWAY', { val: string }>>()
       expectTypeOf(data).toEqualTypeOf<undefined>()
       expectTypeOf(isDefined).toEqualTypeOf<boolean>()

packages/client/src/utils.test.ts

@@ -4,22 +4,22 @@ import { resolveFriendlyClientOptions, safe } from './utils'
 it('safe', async () => {
   const r1 = await safe(Promise.resolve(1))
   expect([...r1]).toEqual([null, 1, false, true])
-  expect({ ...r1 }).toEqual(expect.objectContaining({ error: null, data: 1, isDefined: false, success: true }))
+  expect({ ...r1 }).toEqual(expect.objectContaining({ error: null, data: 1, isDefined: false, isSuccess: true }))
 
   const e2 = new Error('error')
   const r2 = await safe(Promise.reject(e2))
   expect([...r2]).toEqual([e2, undefined, false, false])
-  expect({ ...r2 }).toEqual(expect.objectContaining({ error: e2, data: undefined, isDefined: false, success: false }))
+  expect({ ...r2 }).toEqual(expect.objectContaining({ error: e2, data: undefined, isDefined: false, isSuccess: false }))
 
   const e3 = new ORPCError('BAD_GATEWAY', { defined: true })
   const r3 = await safe(Promise.reject(e3))
   expect([...r3]).toEqual([e3, undefined, true, false])
-  expect({ ...r3 }).toEqual(expect.objectContaining({ error: e3, data: undefined, isDefined: true, success: false }))
+  expect({ ...r3 }).toEqual(expect.objectContaining({ error: e3, data: undefined, isDefined: true, isSuccess: false }))
 
   const e4 = new ORPCError('BAD_GATEWAY')
   const r4 = await safe(Promise.reject(e4))
   expect([...r4]).toEqual([e4, undefined, false, false])
-  expect({ ...r4 }).toEqual(expect.objectContaining({ error: e4, data: undefined, isDefined: false, success: false }))
+  expect({ ...r4 }).toEqual(expect.objectContaining({ error: e4, data: undefined, isDefined: false, isSuccess: false }))
 })
 
 it('resolveFriendlyClientOptions', () => {

packages/client/src/utils.ts

@@ -4,19 +4,19 @@ import type { ClientContext, ClientOptions, ClientPromiseResult, FriendlyClientO
 import { isDefinedError } from './error'
 
 export type SafeResult<TOutput, TError> =
-  | [error: null, data: TOutput, isDefined: false, success: true]
-  & { error: null, data: TOutput, isDefined: false, success: true }
-  | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false]
-  & { error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false }
-  | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false]
-  & { error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false }
+  | [error: null, data: TOutput, isDefined: false, isSuccess: true]
+  & { error: null, data: TOutput, isDefined: false, isSuccess: true }
+  | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false]
+  & { error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false }
+  | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false]
+  & { error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false }
 
 export async function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>> {
   try {
     const output = await promise
     return Object.assign(
       [null, output, false, true] satisfies [null, TOutput, false, true],
-      { error: null, data: output, isDefined: false as const, success: true as const },
+      { error: null, data: output, isDefined: false as const, isSuccess: true as const },
     )
   }
   catch (e) {
@@ -25,13 +25,13 @@ export async function safe<TOutput, TError = ThrowableError>(promise: ClientProm
     if (isDefinedError(error)) {
       return Object.assign(
         [error, undefined, true, false] satisfies [typeof error, undefined, true, false],
-        { error, data: undefined, isDefined: true as const, success: false as const },
+        { error, data: undefined, isDefined: true as const, isSuccess: false as const },
       )
     }
 
     return Object.assign(
       [error as Exclude<TError, ORPCError<any, any>>, undefined, false, false] satisfies [Exclude<TError, ORPCError<any, any>>, undefined, false, false],
-      { error: error as Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false as const, success: false as const },
+      { error: error as Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false as const, isSuccess: false as const },
     )
   }
 }