feat: allow string enums for errors

Author: darshkpatel

__tests__/typescript-stress.test.ts

@@ -25,6 +25,12 @@ import { flattenErrorType, ProcedureErrorSchemaType } from '../router/errors';
 import { ReadableImpl } from '../router/streams';
 import { createMockTransportNetwork } from '../testUtil/fixtures/mockTransport';
 
+enum TestErrorCodes {
+  ERROR_ONE = 'ERROR_ONE',
+  ERROR_TWO = 'ERROR_TWO',
+  ERROR_THREE = 'ERROR_THREE',
+}
+
 const requestData = Type.Union([
   Type.Object({ a: Type.Number() }),
   Type.Object({ c: Type.String() }),
@@ -479,6 +485,53 @@ describe('Procedure error schema', () => {
       );
     });
 
+    test('object with enum code', () => {
+      acceptErrorSchema(
+        Type.Object({
+          code: Type.Enum(TestErrorCodes),
+          message: Type.String(),
+        }),
+      );
+    });
+
+    test('union containing enum-based error schemas', () => {
+      acceptErrorSchema(
+        Type.Union([
+          Type.Object({
+            code: Type.Enum(TestErrorCodes),
+            message: Type.String(),
+          }),
+          Type.Object({
+            code: Type.Literal('OTHER_ERROR'),
+            message: Type.String(),
+          }),
+        ]),
+      );
+    });
+
+    test('flattenErrorType with enum-based error schemas', () => {
+      acceptErrorSchema(
+        flattenErrorType(
+          Type.Union([
+            Type.Object({
+              code: Type.Enum(TestErrorCodes),
+              message: Type.String(),
+            }),
+            Type.Union([
+              Type.Object({
+                code: Type.Literal('ERROR_4'),
+                message: Type.String(),
+              }),
+              Type.Object({
+                code: Type.Literal('ERROR_5'),
+                message: Type.String(),
+              }),
+            ]),
+          ]),
+        ),
+      );
+    });
+
     test('union of union', () => {
       acceptErrorSchema(
         flattenErrorType(

router/errors.ts

@@ -1,6 +1,7 @@
 import {
   Kind,
   Static,
+  TEnum,
   TLiteral,
   TNever,
   TObject,
@@ -32,13 +33,18 @@ export const CANCEL_CODE = 'CANCEL';
 
 type TLiteralString = TLiteral<string>;
 
+/**
+ * String literals or string enums for error codes.
+ */
+type TStringCode = TLiteralString | TEnum<Record<string, string>>;
+
 export type BaseErrorSchemaType =
   | TObject<{
-      code: TLiteralString;
+      code: TStringCode;
       message: TLiteralString | TString;
     }>
   | TObject<{
-      code: TLiteralString;
+      code: TStringCode;
       message: TLiteralString | TString;
       extras: TSchema;
     }>;
@@ -139,7 +145,9 @@ function isUnion(schema: TSchema): schema is TUnion {
 type Flatten<T> = T extends BaseErrorSchemaType
   ? T
   : T extends TUnion<Array<infer U extends TSchema>>
-  ? Flatten<U>
+  ? U extends BaseErrorSchemaType
+    ? TUnion<Array<U>>
+    : Flatten<U>
   : unknown;
 
 /**