@mohamedatia/fly-design-system 2.11.0 → 2.12.0

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

@@ -823,64 +823,44 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.5", ngImpor
         }] });
 
 /**
- * Publishes a {@link WindowHelpHint} for the current window so the shell's
- * titlebar Help button deeplinks the help-center reader to the article most
- * relevant to where the user is.
- *
- * This is the **publisher twin** of the shell's `WindowHelpHintService`
- * (the listener). It exists in the design system so that **any app — and
- * especially a federated remote — publishes hints the same way**, without
+ * Publishes a {@link WindowHelpHint} for a window so the shell's titlebar Help
+ * button deeplinks the help-center reader to the article most relevant to where
+ * the user is. The **publisher twin** of the shell's `WindowHelpHintService`
+ * (the listener): it exists in the design system so that **any app — in-shell
+ * OS-Core app or federated remote — publishes hints the same way**, without
  * hand-rolling the cross-bundle CustomEvent contract.
  *
  * **Why a `window` CustomEvent and not the `WINDOW_HELP_HINT` DI token?**
- * Native Federation can split an `InjectionToken` instance across the host and
- * remote bundles, so a remote that injects `WINDOW_HELP_HINT` may get a
+ * Native Federation can split an `InjectionToken` instance across host and
+ * remote bundles, so a remote that injects `WINDOW_HELP_HINT` may receive a
  * different token than the one the shell provides. The string-keyed
- * {@link FLY_WINDOW_HELP_HINT_EVENT} crosses bundles reliably; the shell
- * mirrors it into the matching per-window hint signal. In-shell (OS-Core) apps
- * may still use the DI token directly, but this service works for them too.
- *
- * **Imperative by design.** The service holds no signals and runs no effect —
- * the *app* owns its reactivity (route + state → resolved hint) and pushes the
- * result via {@link setHint}. The design system owns only the wire format. A
- * hint set before {@link bindWindow} is buffered and emitted once the window id
- * arrives, so call order doesn't matter.
+ * {@link FLY_WINDOW_HELP_HINT_EVENT} crosses bundles reliably; the shell mirrors
+ * it into the matching per-window hint signal.
  *
- * Usage (typically from the remote root + its feature components):
- * ```ts
- * private help = inject(FlyWindowHelpService);
- * constructor() {
- *   this.help.bindWindow(inject(WINDOW_DATA, { optional: true })?.id);
- *   effect(() => this.help.setHint(this.resolvedHint())); // app-specific
- * }
- * ```
+ * **Why a per-window handle and not `bindWindow`/`setHint` state?**
+ * This service is `providedIn: 'root'` and the design system is a shared
+ * Native-Federation singleton, so a *single* instance is shared across the
+ * shell and every concurrently-open window (multiple in-shell apps, multiple
+ * remotes). A handle closes over its window id, so two windows never clobber a
+ * shared "current window" — each handle targets only its own titlebar.
  */
 class FlyWindowHelpService {
-    windowId = null;
-    hint = null;
-    /**
-     * Bind (or clear) the host window id — typically once, from the app root,
-     * with `WINDOW_DATA.id`. Re-emits the current hint for the (new) window.
-     * Passing null/undefined (standalone, no shell) makes publishing a no-op.
-     */
-    bindWindow(windowId) {
-        this.windowId = windowId ?? null;
-        this.publish();
-    }
     /**
-     * Set the active hint (or null to clear — the shell then reverts to the
-     * window's own `appId`). Emits immediately when a window is bound; otherwise
-     * the value is buffered and emitted on the next {@link bindWindow}.
+     * Returns a publisher bound to a single window. Call once per window (e.g.
+     * from the app root with `WINDOW_DATA.id`) and keep the handle. A
+     * null/undefined id (standalone, no shell) yields a handle whose `setHint`
+     * is a no-op.
      */
-    setHint(hint) {
-        this.hint = hint;
-        this.publish();
-    }
-    publish() {
-        if (typeof window === 'undefined' || !this.windowId)
-            return;
-        const detail = { windowId: this.windowId, hint: this.hint };
-        window.dispatchEvent(new CustomEvent(FLY_WINDOW_HELP_HINT_EVENT, { detail }));
+    forWindow(windowId) {
+        const id = windowId ?? null;
+        return {
+            setHint: (hint) => {
+                if (typeof window === 'undefined' || !id)
+                    return;
+                const detail = { windowId: id, hint };
+                window.dispatchEvent(new CustomEvent(FLY_WINDOW_HELP_HINT_EVENT, { detail }));
+            },
+        };
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.5", ngImport: i0, type: FlyWindowHelpService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.5", ngImport: i0, type: FlyWindowHelpService, providedIn: 'root' });