fix: update types for no-restricted-imports rule (#19060)

snitin315 · web-flow · commit fd33f1315ac5 · 2024-11-14T20:30:17.000+05:30
diff --git a/lib/types/rules/ecmascript-6.d.ts b/lib/types/rules/ecmascript-6.d.ts
@@ -27,6 +27,37 @@
 
 import { Linter } from "../index";
 
+export interface NoRestrictedImportPathCommonOptions {
+    name: string;
+    message?: string;
+}
+
+export type EitherImportNamesOrAllowImportName =
+  | { importNames?: string[]; allowImportNames?: never }
+  | { allowImportNames?: string[]; importNames?: never }
+
+export type ValidNoRestrictedImportPathOptions = NoRestrictedImportPathCommonOptions & EitherImportNamesOrAllowImportName;
+
+export interface NoRestrictedImportPatternCommonOptions {
+    message?: string;
+    caseSensitive?: boolean;
+}
+
+// Base type for group or regex constraint, ensuring mutual exclusivity
+export type EitherGroupOrRegEx =
+  | { group: string[]; regex?: never }
+  | { regex: string; group?: never };
+
+// Base type for import name specifiers, ensuring mutual exclusivity
+export type EitherNameSpecifiers = 
+    | { importNames: string[]; allowImportNames?: never; importNamePattern?: never; allowImportNamePattern?: never }
+    | { importNamePattern: string; allowImportNames?: never; importNames?: never; allowImportNamePattern?: never }
+    | { allowImportNames: string[]; importNames?: never; importNamePattern?: never; allowImportNamePattern?: never }
+    | { allowImportNamePattern: string; importNames?: never; allowImportNames?: never; importNamePattern?: never }
+
+// Adds oneOf and not constraints, ensuring group or regex are present and mutually exclusive sets for importNames, allowImportNames, etc., as per the schema.
+export type ValidNoRestrictedImportPatternOptions = NoRestrictedImportPatternCommonOptions & EitherGroupOrRegEx & EitherNameSpecifiers;
+
 export interface ECMAScript6 extends Linter.RulesRecord {
     /**
      * Rule to require braces around arrow function bodies.
@@ -291,23 +322,12 @@ export interface ECMAScript6 extends Linter.RulesRecord {
         [
             ...Array<
                 | string
-                | {
-                    name: string;
-                    importNames?: string[] | undefined;
-                    message?: string | undefined;
-                }
+                | ValidNoRestrictedImportPathOptions
                 | Partial<{
-                    paths: Array<
-                        | string
-                        | {
-                            name: string;
-                            importNames?: string[] | undefined;
-                            message?: string | undefined;
-                        }
-                    >;
-                    patterns: string[];
-                }>
-            >,
+                      paths: Array<string | ValidNoRestrictedImportPathOptions>;
+                      patterns: Array<string | ValidNoRestrictedImportPatternOptions>;
+                  }>
+            >
         ]
     >;
 
