@syntrologie/adapt-nav 2.16.0 → 2.17.0

package/dist/schema.d.ts

@@ -38,27 +38,27 @@ export declare const NavTipSchema: z.ZodEffects<z.ZodObject<{
         category: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     }, {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     }>;
     /** Per-item activation strategy (null = always show) */
@@ -572,21 +572,27 @@ export declare const NavTipSchema: z.ZodEffects<z.ZodObject<{
         why: string;
         confidence?: number | undefined;
     }>>;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    validation: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     kind: "nav:tip";
     config: {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -680,18 +686,21 @@ export declare const NavTipSchema: z.ZodEffects<z.ZodObject<{
 }, {
     kind: "nav:tip";
     config: {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -786,17 +795,20 @@ export declare const NavTipSchema: z.ZodEffects<z.ZodObject<{
     kind: "nav:tip";
     config: {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -890,18 +902,21 @@ export declare const NavTipSchema: z.ZodEffects<z.ZodObject<{
 }, {
     kind: "nav:tip";
     config: {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -1025,27 +1040,27 @@ export declare const NavLinkSchema: z.ZodEffects<z.ZodObject<{
         category: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     }, {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     }>;
     /** Per-item activation strategy (null = always show) */
@@ -1559,21 +1574,27 @@ export declare const NavLinkSchema: z.ZodEffects<z.ZodObject<{
         why: string;
         confidence?: number | undefined;
     }>>;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    validation: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     kind: "nav:tip";
     config: {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -1667,18 +1688,21 @@ export declare const NavLinkSchema: z.ZodEffects<z.ZodObject<{
 }, {
     kind: "nav:tip";
     config: {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -1773,17 +1797,20 @@ export declare const NavLinkSchema: z.ZodEffects<z.ZodObject<{
     kind: "nav:tip";
     config: {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -1877,18 +1904,21 @@ export declare const NavLinkSchema: z.ZodEffects<z.ZodObject<{
 }, {
     kind: "nav:tip";
     config: {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -2022,27 +2052,27 @@ export declare const configSchema: z.ZodObject<{
             category: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         }, {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         }>;
         /** Per-item activation strategy (null = always show) */
@@ -2556,21 +2586,27 @@ export declare const configSchema: z.ZodObject<{
             why: string;
             confidence?: number | undefined;
         }>>;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        validation: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         kind: "nav:tip";
         config: {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -2664,18 +2700,21 @@ export declare const configSchema: z.ZodObject<{
     }, {
         kind: "nav:tip";
         config: {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -2770,17 +2809,20 @@ export declare const configSchema: z.ZodObject<{
         kind: "nav:tip";
         config: {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -2874,18 +2916,21 @@ export declare const configSchema: z.ZodObject<{
     }, {
         kind: "nav:tip";
         config: {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -2984,17 +3029,20 @@ export declare const configSchema: z.ZodObject<{
         kind: "nav:tip";
         config: {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -3094,18 +3142,21 @@ export declare const configSchema: z.ZodObject<{
     actions?: {
         kind: "nav:tip";
         config: {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -3255,18 +3306,21 @@ export declare const navigationTargetsSchema: z.ZodOptional<z.ZodArray<z.ZodObje
 export declare function validateNavTip(data: unknown): z.SafeParseReturnType<{
     kind: "nav:tip";
     config: {
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         external?: boolean | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -3361,17 +3415,20 @@ export declare function validateNavTip(data: unknown): z.SafeParseReturnType<{
     kind: "nav:tip";
     config: {
         external: boolean;
-        id: string;
         title: string;
+        id: string;
         description: string;
+        href?: string | undefined;
         icon?: string | undefined;
         anchor?: {
             selector: string;
             route: string | string[];
         } | undefined;
-        href?: string | undefined;
         category?: string | undefined;
     };
+    title?: string | undefined;
+    description?: string | undefined;
+    validation?: string[] | undefined;
     triggerWhen?: {
         type: "rules";
         rules: {
@@ -3475,18 +3532,21 @@ export declare function validateNavConfig(data: unknown): z.SafeParseReturnType<
     actions?: {
         kind: "nav:tip";
         config: {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -3585,17 +3645,20 @@ export declare function validateNavConfig(data: unknown): z.SafeParseReturnType<
         kind: "nav:tip";
         config: {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -3726,27 +3789,27 @@ export declare const actionStepSchemas: {
             category: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         }, {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         }>;
         /** Per-item activation strategy (null = always show) */
@@ -4260,21 +4323,27 @@ export declare const actionStepSchemas: {
             why: string;
             confidence?: number | undefined;
         }>>;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        validation: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         kind: "nav:tip";
         config: {
             external: boolean;
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -4368,18 +4437,21 @@ export declare const actionStepSchemas: {
     }, {
         kind: "nav:tip";
         config: {
-            id: string;
             title: string;
+            id: string;
             description: string;
+            href?: string | undefined;
             external?: boolean | undefined;
             icon?: string | undefined;
             anchor?: {
                 selector: string;
                 route: string | string[];
             } | undefined;
-            href?: string | undefined;
             category?: string | undefined;
         };
+        title?: string | undefined;
+        description?: string | undefined;
+        validation?: string[] | undefined;
         triggerWhen?: {
             type: "rules";
             rules: {
@@ -4518,27 +4590,27 @@ export declare const tileWidgets: {
                 category: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 external: boolean;
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             }, {
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 external?: boolean | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             }>;
             /** Per-item activation strategy (null = always show) */
@@ -5052,21 +5124,27 @@ export declare const tileWidgets: {
                 why: string;
                 confidence?: number | undefined;
             }>>;
+            title: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            validation: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         }, "strip", z.ZodTypeAny, {
             kind: "nav:tip";
             config: {
                 external: boolean;
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5160,18 +5238,21 @@ export declare const tileWidgets: {
         }, {
             kind: "nav:tip";
             config: {
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 external?: boolean | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5266,17 +5347,20 @@ export declare const tileWidgets: {
             kind: "nav:tip";
             config: {
                 external: boolean;
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5370,18 +5454,21 @@ export declare const tileWidgets: {
         }, {
             kind: "nav:tip";
             config: {
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 external?: boolean | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5480,17 +5567,20 @@ export declare const tileWidgets: {
             kind: "nav:tip";
             config: {
                 external: boolean;
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5590,18 +5680,21 @@ export declare const tileWidgets: {
         actions?: {
             kind: "nav:tip";
             config: {
-                id: string;
                 title: string;
+                id: string;
                 description: string;
+                href?: string | undefined;
                 external?: boolean | undefined;
                 icon?: string | undefined;
                 anchor?: {
                     selector: string;
                     route: string | string[];
                 } | undefined;
-                href?: string | undefined;
                 category?: string | undefined;
             };
+            title?: string | undefined;
+            description?: string | undefined;
+            validation?: string[] | undefined;
             triggerWhen?: {
                 type: "rules";
                 rules: {
@@ -5695,4 +5788,21 @@ export declare const tileWidgets: {
         }[] | undefined;
     }>;
 }[];
+export declare const CAPABILITIES_DOCUMENTATION: {
+    packageId: string;
+    description: string;
+    whenToUse: {
+        goal: string;
+        action: string;
+    }[];
+    conventions: {
+        name: string;
+        description: string;
+    }[];
+    events: {
+        name: string;
+        when: string;
+        props: string;
+    }[];
+};
 //# sourceMappingURL=schema.d.ts.map