@mohamedatia/fly-design-system 2.7.1 → 2.7.2

package/fesm2022/mohamedatia-fly-design-system.mjs

@@ -395,6 +395,40 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.5", ngImpor
  * routing.
  */
 const FLY_REMOTE_ROUTES = new InjectionToken('FLY_REMOTE_ROUTES');
+/**
+ * Optional injection token a remote provides at its root to declare the shell
+ * mount path prefix (e.g. `'/desktop'`). When set, `FlyRemoteRouter.segments()`
+ * strips this prefix from `window.location.pathname` before matching routes.
+ *
+ * **Why this is needed:** In embedded mode the remote is loaded via
+ * `NgComponentOutlet` inside the shell SPA. The shell's own Angular route may
+ * leave `window.location.pathname` as `/desktop` (or any shell-level path).
+ * Without stripping that prefix, `segments()` returns `['desktop']` which
+ * matches none of the remote's Circles-internal routes (e.g. `''`, `'signals'`,
+ * `'signals/:id'`), so `<fly-remote-router-outlet>` renders nothing.
+ *
+ * **Default behaviour (token absent):** `FlyRemoteRouter` initialises `_url`
+ * to `'/'` in embedded mode, completely ignoring `window.location.pathname`.
+ * This is safe because the shell does not push the remote's logical URL into
+ * browser history — only `navigate()` / `navigateByUrl()` calls do.
+ *
+ * **Usage in a remote root component:**
+ * ```ts
+ * providers: [
+ *   FlyRemoteRouter,
+ *   { provide: FLY_REMOTE_ROUTES, useValue: MY_ROUTES },
+ *   { provide: FLY_REMOTE_BASE_PATH, useValue: '/desktop' },
+ * ]
+ * ```
+ *
+ * With `basePath = '/desktop'` and `window.location.pathname = '/desktop'`,
+ * the stripped URL is `'/'` → `segments() = []` → matches the `''` default
+ * route. With pathname `'/desktop/signals/abc'`, segments become
+ * `['signals', 'abc']` → matches `'signals/:id'`.
+ *
+ * Available since design-system **2.7.2**.
+ */
+const FLY_REMOTE_BASE_PATH = new InjectionToken('FLY_REMOTE_BASE_PATH');
 /**
  * Match a route's path pattern against URL segments. Returns the captured params
  * map on a successful match, or `null` if the pattern can't match. Empty path
@@ -489,6 +523,15 @@ class FlyRemoteRouter {
      * driving its own switch/template — `matchedRoute` stays `null`.
      */
     routes = inject(FLY_REMOTE_ROUTES, { optional: true }) ?? [];
+    /**
+     * Shell mount path prefix to strip from `window.location.pathname` when
+     * deriving the initial URL in embedded mode. See `FLY_REMOTE_BASE_PATH` docs.
+     *
+     * When absent (the common case), the embedded router initialises `_url` to
+     * `'/'` and ignores `window.location.pathname` entirely — correct because the
+     * shell SPA never encodes the remote's logical route into the browser URL.
+     */
+    basePath = inject(FLY_REMOTE_BASE_PATH, { optional: true }) ?? null;
     /**
      * True when this remote is rendered inside the FlyOS desktop shell.
      *
@@ -565,9 +608,16 @@ class FlyRemoteRouter {
             });
         }
         else if (this.isEmbedded) {
-            // Embedded: seed from current browser location on initial load.
+            // Embedded: the shell SPA keeps its own route in window.location.pathname
+            // (e.g. '/desktop') which is meaningless for the remote's route table.
+            // Default: initialise to '/' so the remote's empty-path default route
+            // matches on first render. When FLY_REMOTE_BASE_PATH is provided, strip
+            // it from pathname first — useful if the shell does push a remote-aware
+            // URL (e.g. '/desktop/signals/abc' with basePath '/desktop').
             if (typeof window !== 'undefined') {
-                this._url.set(window.location.pathname || '/');
+                const rawPath = window.location.pathname || '/';
+                const initialUrl = this._resolveEmbeddedInitialUrl(rawPath);
+                this._url.set(initialUrl);
                 // Listen for browser back/forward so segments() stays in sync with
                 // history entries pushed by navigate() / navigateByUrl().
                 const onPopState = (event) => {
@@ -623,6 +673,34 @@ class FlyRemoteRouter {
             history.back();
         }
     }
+    /**
+     * Resolve the logical URL to seed `_url` from on embedded initial load.
+     *
+     * - No basePath: always return `'/'`. The shell's SPA path (e.g. `/desktop`)
+     *   is irrelevant to the remote — `navigate()` is the only thing that should
+     *   move the remote's URL.
+     * - basePath provided: strip it from `rawPath`. If rawPath starts with the
+     *   basePath, the remainder becomes the seed URL (normalised to start with
+     *   `'/'`). If it doesn't match (e.g. shell changed its own route), fall back
+     *   to `'/'` rather than surfacing shell-specific segments to the remote's
+     *   route table.
+     */
+    _resolveEmbeddedInitialUrl(rawPath) {
+        if (!this.basePath) {
+            // Default: ignore the shell's pathname, start at remote root.
+            return '/';
+        }
+        const base = this.basePath.endsWith('/') ? this.basePath.slice(0, -1) : this.basePath;
+        if (rawPath === base || rawPath === base + '/') {
+            return '/';
+        }
+        if (rawPath.startsWith(base + '/')) {
+            const remainder = rawPath.slice(base.length);
+            return remainder.startsWith('/') ? remainder : '/' + remainder;
+        }
+        // Shell path doesn't begin with our basePath — fall through to root.
+        return '/';
+    }
     /**
      * In embedded mode: push a real browser history entry (so back/forward work)
      * and update the internal signal synchronously.
@@ -4219,5 +4297,5 @@ const AUDIENCE_ERROR_CODES = {
  * Generated bundle index. Do not edit.
  */
 
-export { AGENT_DRAG_MIME, AGENT_PAYLOAD_VERSION, AUDIENCE_ERROR_CODES, AUDIENCE_LIMITS, AUDIENCE_PRESETS, AUDIENCE_TERM_KINDS, AgentCommandRegistry, AgentDropRegistry, AgentPayloadOversizeError, AudienceBuilderComponent, AuthService, ContextMenuComponent, DEFAULT_AGENT_PAYLOAD_LIMITS, DEFAULT_FLY_THEME_MODE, DialogResult, FLY_LOCALE_CATALOG, FLY_REMOTE_ROUTES, FLY_THEME_MODE_IDS, FlyAgentDraggableDirective, FlyBlockUiComponent, FlyFileUploadComponent, FlyImageUploadComponent, FlyRemoteRouter, FlyRemoteRouterOutletComponent, FlyThemeService, I18nService, LAUNCH_CONTEXT, MessageBoxButtons, MessageBoxComponent, MessageBoxIcon, MessageBoxService, MockAuthService, RTL_LOCALE_SET, SHARE_ORG_CHART_SYSTEM_KEY_APPS, SHARE_ORG_CHART_SYSTEM_KEY_DEFAULT, SHARE_PANEL_DEFAULT_FILE_LEVELS, SharePanelComponent, StandaloneWindowManagerService, TranslatePipe, WINDOW_DATA, WindowManagerService, findLocaleByDialect, findLocaleByPrefix, isRtlLocale, isRtlLocaleEntry, loadRemoteStyles, matchFlyRoutePattern, normalizeFlyTheme, trimAgentPayload, trimAgentString, unloadRemoteStyles, utf8ByteLength, validateAgentPayload };
+export { AGENT_DRAG_MIME, AGENT_PAYLOAD_VERSION, AUDIENCE_ERROR_CODES, AUDIENCE_LIMITS, AUDIENCE_PRESETS, AUDIENCE_TERM_KINDS, AgentCommandRegistry, AgentDropRegistry, AgentPayloadOversizeError, AudienceBuilderComponent, AuthService, ContextMenuComponent, DEFAULT_AGENT_PAYLOAD_LIMITS, DEFAULT_FLY_THEME_MODE, DialogResult, FLY_LOCALE_CATALOG, FLY_REMOTE_BASE_PATH, FLY_REMOTE_ROUTES, FLY_THEME_MODE_IDS, FlyAgentDraggableDirective, FlyBlockUiComponent, FlyFileUploadComponent, FlyImageUploadComponent, FlyRemoteRouter, FlyRemoteRouterOutletComponent, FlyThemeService, I18nService, LAUNCH_CONTEXT, MessageBoxButtons, MessageBoxComponent, MessageBoxIcon, MessageBoxService, MockAuthService, RTL_LOCALE_SET, SHARE_ORG_CHART_SYSTEM_KEY_APPS, SHARE_ORG_CHART_SYSTEM_KEY_DEFAULT, SHARE_PANEL_DEFAULT_FILE_LEVELS, SharePanelComponent, StandaloneWindowManagerService, TranslatePipe, WINDOW_DATA, WindowManagerService, findLocaleByDialect, findLocaleByPrefix, isRtlLocale, isRtlLocaleEntry, loadRemoteStyles, matchFlyRoutePattern, normalizeFlyTheme, trimAgentPayload, trimAgentString, unloadRemoteStyles, utf8ByteLength, validateAgentPayload };
 //# sourceMappingURL=mohamedatia-fly-design-system.mjs.map