fix(store): improve error for forbidden characters in createActionGro…

…up (#3496)
ngrx · Jul 21, 2022 · 398fbed · 398fbed
1 parent bdb8634
commit 398fbed
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 31 deletions.
diff --git a/modules/store/spec/types/action_group_creator.spec.ts b/modules/store/spec/types/action_group_creator.spec.ts
@@ -164,7 +164,7 @@ describe('createActionGroup', () => {
                   '${char}Load Books Success': emptyProps(),
                 },
               });
-          `).toFail(/event name cannot contain/);
+          `).toFail(/event name cannot contain the following characters:/);
           });
 
           it(`should fail when event name contains ${char} in the middle`, () => {
@@ -175,7 +175,7 @@ describe('createActionGroup', () => {
                   'Load Books ${char} Success': emptyProps(),
                 },
               });
-          `).toFail(/event name cannot contain/);
+          `).toFail(/event name cannot contain the following characters:/);
           });
 
           it(`should fail when event name contains ${char} in the end`, () => {
@@ -186,7 +186,7 @@ describe('createActionGroup', () => {
                   'Load Books Success${char}': emptyProps(),
                 },
               });
-          `).toFail(/event name cannot contain/);
+          `).toFail(/event name cannot contain the following characters:/);
           });
         });
       });

diff --git a/modules/store/src/action_group_creator_models.ts b/modules/store/src/action_group_creator_models.ts
@@ -28,39 +28,21 @@ type TitleCase<Str extends string> = Str extends `${infer First} ${infer Rest}`
   ? `${Capitalize<First>} ${TitleCase<Rest>}`
   : Capitalize<Str>;
 
-type ForbiddenCharacters =
-  | '/'
-  | '\\'
-  | '|'
-  | '<'
-  | '>'
-  | '['
-  | ']'
-  | '{'
-  | '}'
-  | '('
-  | ')'
-  | '.'
-  | ','
-  | '!'
-  | '?'
-  | '#'
-  | '%'
-  | '^'
-  | '&'
-  | '*'
-  | '+'
-  | '-'
-  | '~'
-  | "'"
-  | '"'
-  | '`';
+type ForbiddenCharactersStr =
+  '/ \\ | < > [ ] { } ( ) . , ! ? # % ^ & * + - ~ \' " `';
+
+type ForbiddenCharacters<Str extends string = ForbiddenCharactersStr> =
+  Str extends `${infer First} ${infer Rest}`
+    ? First | ForbiddenCharacters<Rest>
+    : Str extends ''
+    ? never
+    : Str;
 
 type ForbiddenCharactersCheck<
   Str extends string,
   Name extends string
 > = Str extends `${infer _}${ForbiddenCharacters}${infer _}`
-  ? `${Name} cannot contain ${ForbiddenCharacters}`
+  ? `${Name} cannot contain the following characters: ${ForbiddenCharactersStr}`
   : unknown;
 
 type EmptyStringCheck<