errorSchema -> errorResponse

Author: EskiMojo14

packages/toolkit/src/query/core/buildThunks.ts

@@ -745,12 +745,13 @@ export function buildThunks<
           endpointDefinition,
           'transformErrorResponse',
         )
-        const { rawErrorSchema, errorSchema } = endpointDefinition
+        const { rawErrorResponseSchema, errorResponseSchema } =
+          endpointDefinition
 
         let { value, meta } = caughtError
 
-        if (rawErrorSchema) {
-          value = await parseWithSchema(rawErrorSchema, value)
+        if (rawErrorResponseSchema) {
+          value = await parseWithSchema(rawErrorResponseSchema, value)
         }
 
         if (metaSchema) {
@@ -763,9 +764,9 @@ export function buildThunks<
             meta,
             arg.originalArgs,
           )
-          if (errorSchema) {
+          if (errorResponseSchema) {
             transformedErrorResponse = await parseWithSchema(
-              errorSchema,
+              errorResponseSchema,
               transformedErrorResponse,
             )
           }

packages/toolkit/src/query/endpointDefinitions.ts

@@ -108,7 +108,7 @@ type EndpointDefinitionWithQuery<
   rawResponseSchema?: StandardSchemaV1<BaseQueryResult<BaseQuery>>
 
   /** A schema for the error object returned by the `query` or `queryFn`, *before* it's passed to `transformErrorResponse` */
-  rawErrorSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>
+  rawErrorResponseSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>
 }
 
 type EndpointDefinitionWithQueryFn<
@@ -170,7 +170,7 @@ type EndpointDefinitionWithQueryFn<
   transformResponse?: never
   transformErrorResponse?: never
   rawResponseSchema?: never
-  rawErrorSchema?: never
+  rawErrorResponseSchema?: never
 }
 
 type BaseEndpointTypes<QueryArg, BaseQuery extends BaseQueryFn, ResultType> = {
@@ -196,7 +196,7 @@ export type BaseEndpointDefinition<
   responseSchema?: StandardSchemaV1<ResultType>
 
   /** A schema for the error object returned by the `query` or `queryFn` (including `transformErrorResponse` if provided) */
-  errorSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>
+  errorResponseSchema?: StandardSchemaV1<BaseQueryError<BaseQuery>>
 
   /** A schema for the `meta` property returned by the `query` or `queryFn` */
   metaSchema?: StandardSchemaV1<BaseQueryMeta<BaseQuery>>

packages/toolkit/src/query/tests/createApi.test-d.ts

@@ -383,7 +383,7 @@ describe('type tests', () => {
         title: v.string(),
         body: v.string(),
       }) satisfies v.GenericSchema<Post>
-      const errorSchema = v.object({
+      const errorResponseSchema = v.object({
         status: v.number(),
         data: v.unknown(),
       }) satisfies v.GenericSchema<FetchBaseQueryError>
@@ -399,7 +399,7 @@ describe('type tests', () => {
               query: ({ id }) => `/post/${id}`,
               argSchema,
               responseSchema: postSchema,
-              errorSchema,
+              errorResponseSchema,
               metaSchema,
             }),
             bothMismatch: build.query<Post, { id: number }>({
@@ -409,7 +409,7 @@ describe('type tests', () => {
               // @ts-expect-error wrong schema
               responseSchema: v.object({ id: v.string() }),
               // @ts-expect-error wrong schema
-              errorSchema: v.object({ status: v.string() }),
+              errorResponseSchema: v.object({ status: v.string() }),
               // @ts-expect-error wrong schema
               metaSchema: v.object({ request: v.string() }),
             }),
@@ -425,8 +425,8 @@ describe('type tests', () => {
                 id: v.pipe(v.string(), v.transform(Number)),
               }) satisfies v.GenericSchema<any, Post>,
               // @ts-expect-error can't expect different input
-              errorSchema: v.object({
-                ...errorSchema.entries,
+              errorResponseSchema: v.object({
+                ...errorResponseSchema.entries,
                 status: v.pipe(v.string(), v.transform(Number)),
               }) satisfies v.GenericSchema<any, FetchBaseQueryError>,
               // @ts-expect-error can't expect different input
@@ -450,8 +450,8 @@ describe('type tests', () => {
                 id: v.pipe(v.number(), v.transform(String)),
               }) satisfies v.GenericSchema<Post, any>,
               // @ts-expect-error can't provide different output
-              errorSchema: v.object({
-                ...errorSchema.entries,
+              errorResponseSchema: v.object({
+                ...errorResponseSchema.entries,
                 status: v.pipe(v.number(), v.transform(String)),
               }) satisfies v.GenericSchema<FetchBaseQueryError, any>,
               // @ts-expect-error can't provide different output

packages/toolkit/src/query/tests/createApi.test.ts

@@ -1266,7 +1266,7 @@ describe('endpoint schemas', () => {
       endpoints: (build) => ({
         query: build.query<{ success: boolean }, void>({
           query: () => '/error',
-          rawErrorSchema: v.object({
+          rawErrorResponseSchema: v.object({
             status: v.pipe(v.number(), v.minValue(400), v.maxValue(499)),
             data: v.unknown(),
           }),
@@ -1290,7 +1290,7 @@ describe('endpoint schemas', () => {
             data: error,
             error: 'whoops',
           }),
-          errorSchema: v.object({
+          errorResponseSchema: v.object({
             status: v.literal('CUSTOM_ERROR'),
             error: v.literal('oh no'),
             data: v.unknown(),