@syntrologie/adapt-nav 2.13.0 → 2.15.0

package/dist/runtime-lit.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Adaptive Nav - Runtime Module (Lit)
+ *
+ * Runtime manifest for the navigation tips accordion adaptive.
+ * Uses the Lit web component mountable instead of the React one.
+ * Includes widget-based nav tips and navigation action executors
+ * (scrollTo, navigate) previously in adaptive-navigation.
+ */
+import type { ActionExecutor, NavConfig, NavigateAction, NavWidgetRuntime, ScrollToAction } from './types';
+/**
+ * Execute a scrollTo action
+ */
+export declare const executeScrollTo: ActionExecutor<ScrollToAction>;
+/**
+ * Try to navigate using the host framework's native router.
+ * Returns true if a framework router handled the navigation,
+ * false if no framework was detected (caller should use pushState or location.href).
+ *
+ * Using the native router preserves SPA behavior (no full reload),
+ * layout state, scroll position, and framework-specific features
+ * (RSC streaming, view transitions, etc.).
+ */
+export declare function navigateWithFrameworkRouter(url: string): boolean;
+/**
+ * Execute a navigate action
+ */
+export declare const executeNavigate: ActionExecutor<NavigateAction>;
+/**
+ * NavWidgetLitMountable — Mounts the `<syntro-nav-tips>` Lit web component.
+ *
+ * Drop-in companion to NavMountableWidget that avoids React/ReactDOM entirely.
+ * Self-registers the custom element on first use.
+ */
+export declare const NavWidgetLitMountable: {
+    mount(container: HTMLElement, config?: NavConfig & {
+        runtime?: NavWidgetRuntime;
+        instanceId?: string;
+    }): () => void;
+};
+/**
+ * All executors provided by this app.
+ * These are registered with the runtime's ExecutorRegistry.
+ */
+export declare const executors: readonly [{
+    readonly kind: "navigation:scrollTo";
+    readonly executor: ActionExecutor<ScrollToAction>;
+}, {
+    readonly kind: "navigation:navigate";
+    readonly executor: ActionExecutor<NavigateAction>;
+}];
+/**
+ * Runtime manifest for adaptive-nav (Lit variant).
+ *
+ * Provides:
+ * - Navigation action executors (scrollTo, navigate)
+ * - Widget-based nav tips accordion using the Lit web component
+ */
+export declare const runtime: {
+    id: string;
+    version: string;
+    name: string;
+    description: string;
+    /**
+     * Navigation action executors (scrollTo, navigate).
+     */
+    executors: readonly [{
+        readonly kind: "navigation:scrollTo";
+        readonly executor: ActionExecutor<ScrollToAction>;
+    }, {
+        readonly kind: "navigation:navigate";
+        readonly executor: ActionExecutor<NavigateAction>;
+    }];
+    /**
+     * Widget definitions for the runtime's WidgetRegistry.
+     */
+    widgets: {
+        id: string;
+        component: {
+            mount(container: HTMLElement, config?: NavConfig & {
+                runtime?: NavWidgetRuntime;
+                instanceId?: string;
+            }): () => void;
+        };
+        metadata: {
+            name: string;
+            description: string;
+            icon: string;
+        };
+    }[];
+    /**
+     * Extract notify watcher entries from tile config props.
+     * The runtime evaluates these continuously (even with drawer closed)
+     * and publishes nav:tip_revealed when triggerWhen transitions false → true.
+     */
+    notifyWatchers(props: Record<string, unknown>): {
+        id: string;
+        strategy: import("./types").DecisionStrategy<boolean>;
+        eventName: string;
+        eventProps: {
+            tipId: string;
+            title: string | undefined;
+            body: string | undefined;
+            icon: string | undefined;
+        };
+    }[];
+};
+export default runtime;
+//# sourceMappingURL=runtime-lit.d.ts.map

package/dist/runtime-lit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-lit.d.ts","sourceRoot":"","sources":["../src/runtime-lit.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,KAAK,EACV,cAAc,EAEd,SAAS,EACT,cAAc,EAEd,gBAAgB,EAChB,cAAc,EACf,MAAM,SAAS,CAAC;AAMjB;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CA+B1D,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAgDhE;AAgBD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CAuC1D,CAAC;AAMF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;qBAEnB,WAAW,WACb,SAAS,GAAG;QAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;CA2B3E,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;EAGZ,CAAC;AAMX;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;IAMlB;;OAEG;;;;;;;;IAGH;;OAEG;;;;6BAnEU,WAAW,WACb,SAAS,GAAG;gBAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC;gBAAC,UAAU,CAAC,EAAE,MAAM,CAAA;aAAE;;;;;;;;IA+E1E;;;;OAIG;0BACmB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;CAgB9C,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/runtime-lit.js

@@ -0,0 +1,241 @@
+/**
+ * Adaptive Nav - Runtime Module (Lit)
+ *
+ * Runtime manifest for the navigation tips accordion adaptive.
+ * Uses the Lit web component mountable instead of the React one.
+ * Includes widget-based nav tips and navigation action executors
+ * (scrollTo, navigate) previously in adaptive-navigation.
+ */
+import { registerNavWidgetLit } from './NavWidgetLit';
+// ============================================================================
+// Navigation Action Executors (merged from adaptive-navigation)
+// ============================================================================
+/**
+ * Execute a scrollTo action
+ */
+export const executeScrollTo = async (action, context) => {
+    const anchorEl = context.resolveAnchor(action.anchorId);
+    if (!anchorEl) {
+        console.error(`[adaptive-nav] Anchor not found for scrollTo, skipping: ${action.anchorId.selector}`);
+        return { cleanup: () => { } };
+    }
+    // Scroll to element
+    anchorEl.scrollIntoView({
+        behavior: action.behavior ?? 'smooth',
+        block: action.block ?? 'center',
+        inline: action.inline ?? 'nearest',
+    });
+    context.publishEvent('action.applied', {
+        id: context.generateId(),
+        kind: 'navigation:scrollTo',
+        anchorId: action.anchorId,
+        behavior: action.behavior ?? 'smooth',
+    });
+    return {
+        cleanup: () => {
+            // Optionally restore scroll position on revert
+        },
+    };
+};
+/**
+ * Try to navigate using the host framework's native router.
+ * Returns true if a framework router handled the navigation,
+ * false if no framework was detected (caller should use pushState or location.href).
+ *
+ * Using the native router preserves SPA behavior (no full reload),
+ * layout state, scroll position, and framework-specific features
+ * (RSC streaming, view transitions, etc.).
+ */
+export function navigateWithFrameworkRouter(url) {
+    if (typeof window === 'undefined')
+        return false;
+    const w = window;
+    // Next.js — window.next.router.push() triggers App Router navigation
+    // with RSC fetch, layout preservation, and loading states
+    try {
+        const nextRouter = w.next?.router;
+        if (nextRouter?.push) {
+            nextRouter.push(url);
+            return true;
+        }
+    }
+    catch {
+        /* fall through */
+    }
+    // Nuxt 3 — useRouter() isn't accessible from outside Vue, but
+    // $nuxt.$router (Nuxt 2) or window.__NUXT__?.hooks (Nuxt 3) + navigateTo
+    // aren't reliably exposed. Nuxt 2 exposes $nuxt.$router.push().
+    try {
+        if (w.$nuxt?.$router?.push) {
+            w.$nuxt.$router.push(url);
+            return true;
+        }
+    }
+    catch {
+        /* fall through */
+    }
+    // Angular — Angular Router isn't exposed on window by default.
+    // The most reliable approach is to detect Angular and use location.href.
+    if (w.ng || w.getAllAngularRootElements || document.querySelector('[ng-version]')) {
+        window.location.href = url;
+        return true;
+    }
+    // SvelteKit — goto() isn't on window, but __SVELTEKIT_DATA__ confirms the framework.
+    if (w.__SVELTEKIT_DATA__ || document.body?.hasAttribute('data-sveltekit')) {
+        window.location.href = url;
+        return true;
+    }
+    // Astro (View Transitions) — no client-side router API exposed
+    if (document.querySelector('[data-astro-transition-fallback]')) {
+        window.location.href = url;
+        return true;
+    }
+    return false;
+}
+/**
+ * Check if a URL is same-origin as the current page.
+ * Relative URLs (e.g. "/dashboard") are always same-origin.
+ */
+function isSameOrigin(url) {
+    try {
+        const parsed = new URL(url, window.location.origin);
+        return parsed.origin === window.location.origin;
+    }
+    catch {
+        // If URL parsing fails, fall back to full navigation
+        return false;
+    }
+}
+/**
+ * Execute a navigate action
+ */
+export const executeNavigate = async (action, context) => {
+    // Validate URL to prevent javascript: URLs
+    const url = action.url.trim();
+    if (url.toLowerCase().startsWith('javascript:')) {
+        throw new Error('javascript: URLs are not allowed');
+    }
+    const target = action.target ?? '_self';
+    context.publishEvent('action.applied', {
+        id: context.generateId(),
+        kind: 'navigation:navigate',
+        url: action.url,
+        target,
+    });
+    if (target === '_blank') {
+        // Open in new tab
+        window.open(url, '_blank', 'noopener,noreferrer');
+    }
+    else if (!action.forceFullNavigation && isSameOrigin(url)) {
+        // Try the host framework's native router first (Next.js, Nuxt, Angular, etc.)
+        // Falls back to pushState for vanilla SPAs, or location.href as last resort.
+        if (!navigateWithFrameworkRouter(url)) {
+            window.history.pushState(null, '', url);
+            window.dispatchEvent(new PopStateEvent('popstate'));
+        }
+    }
+    else {
+        // Full navigation for cross-origin URLs or when explicitly requested
+        window.location.href = url;
+    }
+    return {
+        cleanup: () => {
+            // Navigation cannot be reverted
+        },
+    };
+};
+// ============================================================================
+// Lit Mountable Widget
+// ============================================================================
+/**
+ * NavWidgetLitMountable — Mounts the `<syntro-nav-tips>` Lit web component.
+ *
+ * Drop-in companion to NavMountableWidget that avoids React/ReactDOM entirely.
+ * Self-registers the custom element on first use.
+ */
+export const NavWidgetLitMountable = {
+    mount(container, config) {
+        registerNavWidgetLit();
+        const el = document.createElement('syntro-nav-tips');
+        const { runtime, instanceId = 'nav-widget', ...navConfig } = config ?? {
+            expandBehavior: 'single',
+            theme: 'auto',
+            actions: [],
+        };
+        // Assign structured props as JS properties (not HTML attributes)
+        Object.assign(el, {
+            config: navConfig,
+            runtime,
+            instanceId,
+        });
+        container.appendChild(el);
+        return () => el.remove();
+    },
+};
+// ============================================================================
+// Executor Definitions for Registration
+// ============================================================================
+/**
+ * All executors provided by this app.
+ * These are registered with the runtime's ExecutorRegistry.
+ */
+export const executors = [
+    { kind: 'navigation:scrollTo', executor: executeScrollTo },
+    { kind: 'navigation:navigate', executor: executeNavigate },
+];
+// ============================================================================
+// App Runtime Manifest
+// ============================================================================
+/**
+ * Runtime manifest for adaptive-nav (Lit variant).
+ *
+ * Provides:
+ * - Navigation action executors (scrollTo, navigate)
+ * - Widget-based nav tips accordion using the Lit web component
+ */
+export const runtime = {
+    id: 'adaptive-nav',
+    version: '2.0.0',
+    name: 'Navigation Tips',
+    description: 'Navigation actions and accordion-based tips with per-item conditional visibility',
+    /**
+     * Navigation action executors (scrollTo, navigate).
+     */
+    executors,
+    /**
+     * Widget definitions for the runtime's WidgetRegistry.
+     */
+    widgets: [
+        {
+            id: 'adaptive-nav:tips',
+            component: NavWidgetLitMountable,
+            metadata: {
+                name: 'Navigation Tips',
+                description: 'Accordion of contextual navigation tips with per-item visibility',
+                icon: '\u{1F9ED}',
+            },
+        },
+    ],
+    /**
+     * Extract notify watcher entries from tile config props.
+     * The runtime evaluates these continuously (even with drawer closed)
+     * and publishes nav:tip_revealed when triggerWhen transitions false → true.
+     */
+    notifyWatchers(props) {
+        const actions = (props.actions ?? []);
+        return actions
+            .filter((a) => a.notify && a.triggerWhen)
+            .map((a) => ({
+            id: `nav:${a.config.id}`,
+            strategy: a.triggerWhen,
+            eventName: 'nav:tip_revealed',
+            eventProps: {
+                tipId: a.config.id,
+                title: a.notify.title,
+                body: a.notify.body,
+                icon: a.notify.icon,
+            },
+        }));
+    },
+};
+export default runtime;

package/dist/runtime.d.ts

@@ -5,7 +5,7 @@
  * Includes widget-based nav tips and navigation action executors
  * (scrollTo, navigate) previously in adaptive-navigation.
  */
-import type { ActionExecutor, NavigateAction, ScrollToAction } from './types';
+import type { ActionExecutor, NavConfig, NavigateAction, NavWidgetRuntime, ScrollToAction } from './types';
 /**
  * Execute a scrollTo action
  */
@@ -24,6 +24,18 @@ export declare function navigateWithFrameworkRouter(url: string): boolean;
  * Execute a navigate action
  */
 export declare const executeNavigate: ActionExecutor<NavigateAction>;
+/**
+ * NavWidgetLitMountable — Mounts the `<syntro-nav-tips>` Lit web component.
+ *
+ * Drop-in companion to NavMountableWidget that avoids React/ReactDOM entirely.
+ * Self-registers the custom element on first use.
+ */
+export declare const NavWidgetLitMountable: {
+    mount(container: HTMLElement, config?: NavConfig & {
+        runtime?: NavWidgetRuntime;
+        instanceId?: string;
+    }): () => void;
+};
 /**
  * All executors provided by this app.
  * These are registered with the runtime's ExecutorRegistry.
@@ -63,8 +75,8 @@ export declare const runtime: {
     widgets: {
         id: string;
         component: {
-            mount(container: HTMLElement, config?: import("./types").NavConfig & {
-                runtime?: import("./types").NavWidgetRuntime;
+            mount(container: HTMLElement, config?: NavConfig & {
+                runtime?: NavWidgetRuntime;
                 instanceId?: string;
             }): (() => void) | undefined;
         };

package/dist/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EACV,cAAc,EAEd,cAAc,EAEd,cAAc,EACf,MAAM,SAAS,CAAC;AAMjB;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CA+B1D,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAgDhE;AAgBD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CAuC1D,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;EAGZ,CAAC;AAMX;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;IAMlB;;OAEG;;;;;;;;IAGH;;OAEG;;;;;uBAqC6lb,CAAC;0BAA8B,CAAC;;;;;;;;;IAxBhob;;;;OAIG;0BACmB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;CAgB9C,CAAC;AAEF,eAAe,OAAO,CAAC"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EACV,cAAc,EAEd,SAAS,EACT,cAAc,EAEd,gBAAgB,EAChB,cAAc,EACf,MAAM,SAAS,CAAC;AAMjB;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CA+B1D,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAgDhE;AAgBD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,cAAc,CAuC1D,CAAC;AAMF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;qBAEnB,WAAW,WACb,SAAS,GAAG;QAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;CA2B3E,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;EAGZ,CAAC;AAMX;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;IAMlB;;OAEG;;;;;;;;IAGH;;OAEG;;;;;uBAqC68Y,CAAC;0BAA8B,CAAC;;;;;;;;;IAxBh/Y;;;;OAIG;0BACmB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;CAgB9C,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/runtime.js

@@ -6,6 +6,7 @@
  * (scrollTo, navigate) previously in adaptive-navigation.
  */
 import { NavMountableWidget } from './NavWidget';
+import { registerNavWidgetLit } from './NavWidgetLit';
 // ============================================================================
 // Navigation Action Executors (merged from adaptive-navigation)
 // ============================================================================
@@ -144,6 +145,34 @@ export const executeNavigate = async (action, context) => {
     };
 };
 // ============================================================================
+// Lit Mountable Widget
+// ============================================================================
+/**
+ * NavWidgetLitMountable — Mounts the `<syntro-nav-tips>` Lit web component.
+ *
+ * Drop-in companion to NavMountableWidget that avoids React/ReactDOM entirely.
+ * Self-registers the custom element on first use.
+ */
+export const NavWidgetLitMountable = {
+    mount(container, config) {
+        registerNavWidgetLit();
+        const el = document.createElement('syntro-nav-tips');
+        const { runtime, instanceId = 'nav-widget', ...navConfig } = config ?? {
+            expandBehavior: 'single',
+            theme: 'auto',
+            actions: [],
+        };
+        // Assign structured props as JS properties (not HTML attributes)
+        Object.assign(el, {
+            config: navConfig,
+            runtime,
+            instanceId,
+        });
+        container.appendChild(el);
+        return () => el.remove();
+    },
+};
+// ============================================================================
 // Executor Definitions for Registration
 // ============================================================================
 /**