@nordcraft/search 1.0.85 → 1.0.87

package/src/types.ts

@@ -59,15 +59,16 @@ export type Code =
   | 'duplicate action argument name'
   | 'duplicate event trigger'
   | 'duplicate formula argument name'
+  | 'duplicate route'
   | 'duplicate url parameter'
   | 'duplicate workflow parameter'
-  | 'duplicate route'
+  | 'image without dimension'
   | 'invalid api parser mode'
   | 'invalid api proxy body setting'
   | 'invalid api proxy cookie setting'
+  | 'invalid component structure'
   | 'invalid element child'
   | 'invalid style syntax'
-  | 'invalid component structure'
   | 'legacy action'
   | 'legacy api'
   | 'legacy formula'
@@ -77,10 +78,10 @@ export type Code =
   | 'no post navigate action'
   | 'no-console'
   | 'no-reference api input'
-  | 'no-reference api'
   | 'no-reference api service'
-  | 'no-reference attribute'
+  | 'no-reference api'
   | 'no-reference attribute in instance'
+  | 'no-reference attribute'
   | 'no-reference component formula'
   | 'no-reference component workflow'
   | 'no-reference component'
@@ -100,24 +101,25 @@ export type Code =
   | 'required element attribute'
   | 'required extension'
   | 'required meta tag'
-  | 'image without dimension'
+  | 'size constraint'
   | 'unknown action argument'
   | 'unknown action event'
   | 'unknown api input'
-  | 'unknown api'
   | 'unknown api service'
+  | 'unknown api'
   | 'unknown attribute'
   | 'unknown classname'
   | 'unknown component attribute'
   | 'unknown component formula input'
   | 'unknown component slot'
+  | 'unknown component'
   | 'unknown context formula'
   | 'unknown context provider formula'
   | 'unknown context provider workflow'
   | 'unknown context provider'
   | 'unknown context workflow'
   | 'unknown cookie'
-  | 'unknown component'
+  | 'unknown css variable'
   | 'unknown event'
   | 'unknown fetch input'
   | 'unknown formula'
@@ -129,12 +131,11 @@ export type Code =
   | 'unknown set url parameter'
   | 'unknown set url parameters'
   | 'unknown trigger event'
+  | 'unknown trigger workflow parameter'
   | 'unknown trigger workflow'
   | 'unknown url parameter'
   | 'unknown variable setter'
   | 'unknown variable'
-  | 'unknown css variable'
-  | 'unknown trigger workflow parameter'
   | 'unknown workflow parameter'
 
 export type Category =
@@ -157,6 +158,7 @@ export type Result = {
   level: Level
   details?: any
   fixes?: FixType[]
+  info: ReportedIssueInfo
 }
 
 export interface ApplicationCookie {
@@ -460,6 +462,11 @@ export type FixType =
   | UnknownApiServiceRuleFix
   | UnknownComponentAttributeRuleFix
 
+interface ReportedIssueInfo {
+  title: string
+  description: string
+}
+
 export interface Rule<
   T = unknown,
   V extends NodeType = NodeType,
@@ -469,7 +476,12 @@ export interface Rule<
   code: Code
   level: Level
   visit: (
-    report: (path: (string | number)[], details?: T, fixes?: FixType[]) => void,
+    report: (args: {
+      path: (string | number)[]
+      info: ReportedIssueInfo
+      details?: T
+      fixes?: FixType[]
+    }) => void,
     data: V,
     state?: ApplicationState | undefined,
   ) => void