@franzzemen/brokenstock-shell 0.6.1 → 0.7.1

package/fesm2022/franzzemen-brokenstock-shell.mjs

@@ -32,6 +32,23 @@ import { MatCheckboxModule } from '@angular/material/checkbox';
 import * as i1$2 from '@angular/material/dialog';
 import { MAT_DIALOG_DATA, MatDialogRef, MatDialogModule } from '@angular/material/dialog';
 
+/**
+ * Does `url` fall inside any of `patterns`? Query string and fragment are
+ * stripped; a pattern matches when the path equals it or continues past it at
+ * a `/`; a `:param` segment matches any one non-empty segment. Same rule as
+ * the lexicon's `matchesRoute`, tested there and here.
+ */
+function matchesRoute(url, patterns) {
+    const path = url.split('?')[0].split('#')[0].replace(/\/+$/, '') || '/';
+    const segments = path.split('/');
+    return patterns.some(pattern => {
+        const want = pattern.replace(/\/+$/, '').split('/');
+        if (want.length > segments.length)
+            return false;
+        return want.every((w, i) => (w.startsWith(':') ? segments[i].length > 0 : w === segments[i]));
+    });
+}
+
 const SHELL_APP_NAME = new InjectionToken('SHELL_APP_NAME');
 const SHELL_MENU_ITEMS = new InjectionToken('SHELL_MENU_ITEMS');
 const SHELL_AUTH_URLS = new InjectionToken('SHELL_AUTH_URLS');
@@ -2557,6 +2574,7 @@ class FaqCommand {
         this.description = 'Open the in-app FAQ help system';
         this.usage = FAQ_USAGE;
         this.requiresAuth = false;
+        this.scope = 'global';
         this.argsSchema = z.array(z.string()).max(50);
     }
     execute(args) {
@@ -2716,6 +2734,7 @@ class CommandService {
         ...(ngDevMode ? [{ debugName: "helpOverlay" }] : /* istanbul ignore next */ []));
         this.authService = inject(AuthenticationService);
         this.registry = inject(CommandRegistryService);
+        this.router = inject(Router);
         this.lastResult = computed(() => {
             const h = this.history();
             return h.length > 0 ? h[h.length - 1].result : null;
@@ -2845,9 +2864,12 @@ class CommandService {
                 '  help — List available commands',
                 // Unavailable commands stay listed, annotated. Removing them would make
                 // the CLI look broken rather than gated.
+                // A command scoped to another screen stays listed too, with its screen
+                // named rather than hidden (trades-tree.prd.md D31): hiding it would
+                // read as a broken CLI.
                 ...registered.map(c => {
                     const availability = c.isAvailable?.();
-                    const suffix = availability && !availability.ok ? `  [unavailable — ${availability.reason}]` : '';
+                    const suffix = availability && !availability.ok ? `  [unavailable — ${availability.reason}]` : this.#scopeSuffix(c.scope);
                     return `  ${c.name} — ${c.description}${suffix}`;
                 }),
             ];
@@ -2894,7 +2916,23 @@ class CommandService {
             return notLoggedIn();
         }
         if (hasHelp) {
-            return { success: true, message: def.usage, timestamp: new Date(), isHelp: true };
+            // `help <command>` is normalised to `<command> help` above, so this is
+            // the one place a command's usage is shown; the screen it works on goes
+            // here (D31).
+            return { success: true, message: def.usage + this.#whereNote(def.scope), timestamp: new Date(), isHelp: true };
+        }
+        // Screen gate (trades-tree.prd.md D30). A command bound to state only one
+        // screen sets is refused off that screen with the screen named, the way
+        // `tab` always did on its own. A command that navigates to its screen is
+        // never refused here — declaring its routes is what lets `help` say where
+        // it lives, and taking the user there is the handler's job (D32).
+        if (def.scope !== 'global' && def.scope.elsewhere === 'refuse' && !matchesRoute(this.router.url, def.scope.routes)) {
+            return {
+                success: false,
+                message: `'${command}' works on ${def.scope.screen}.`,
+                severity: 'error',
+                timestamp: new Date(),
+            };
         }
         // Readiness gate. Deliberately ahead of argument validation: "you can't use
         // this yet, here's why" is more useful than a complaint about the arguments
@@ -2926,7 +2964,17 @@ class CommandService {
         // user decides whether it's worth unlocking. The gate is noted, not enforced.
         const availability = def.isAvailable?.();
         const note = availability && !availability.ok ? `\n\nCurrently unavailable — ${availability.reason}` : '';
-        return { success: true, message: def.usage + note, timestamp: new Date(), isHelp: true };
+        return { success: true, message: def.usage + this.#whereNote(def.scope) + note, timestamp: new Date(), isHelp: true };
+    }
+    /** "Works on the Trades screen." — appended to a scoped command's usage. */
+    #whereNote(scope) {
+        return scope === 'global' ? '' : `\n\nWorks on ${scope.screen}.`;
+    }
+    /** `help`'s annotation for a command scoped to a screen other than the current one. */
+    #scopeSuffix(scope) {
+        if (scope === 'global' || matchesRoute(this.router.url, scope.routes))
+            return '';
+        return `  [${scope.screen}]`;
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.2", ngImport: i0, type: CommandService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "22.1.2", ngImport: i0, type: CommandService, providedIn: 'root' }); }
@@ -3463,5 +3511,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.2", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { AuthenticationService, CLEAR_USAGE, CommandRegistryService, CommandService, CommandTerminal, ConfirmDialog, FAQ_CONTENT_LOADER, FAQ_DEV_EDITOR, FAQ_DEV_MODE, FAQ_DEV_WORKSPACE_ROOT, FAQ_PUBLIC_PUBLISHER, FAQ_PUBLIC_SITE_BASE_URL, FaqAuthoringPanel, FaqHistoryService, FaqMarkdownRendererService, FaqModal, FaqService, HELP_USAGE, HttpFaqContentLoader, KeyboardShortcutService, Login, MainContent, PublicFaqIndex, PublicFaqPage, PublicFaqToc, RegexValidatorDirective, SESSION_TOKEN_KEY, SHELL_APP_NAME, SHELL_AUTH_URLS, SHELL_COMMANDS, SHELL_MENU_ITEMS, SHELL_POST_LOGIN_ROUTE, SHELL_SHARED_SESSION, SessionTokenStore, Shell, SideMenu, StatusBar, TerminalFocusService, TerminalVisibilityService, ThemeService, ThinkingService, audienceAllowed, authGuard, authInterceptor, buildFallbackChain, decideRenewal, guestGuard, provideShellConfig, tokenize };
+export { AuthenticationService, CLEAR_USAGE, CommandRegistryService, CommandService, CommandTerminal, ConfirmDialog, FAQ_CONTENT_LOADER, FAQ_DEV_EDITOR, FAQ_DEV_MODE, FAQ_DEV_WORKSPACE_ROOT, FAQ_PUBLIC_PUBLISHER, FAQ_PUBLIC_SITE_BASE_URL, FaqAuthoringPanel, FaqHistoryService, FaqMarkdownRendererService, FaqModal, FaqService, HELP_USAGE, HttpFaqContentLoader, KeyboardShortcutService, Login, MainContent, PublicFaqIndex, PublicFaqPage, PublicFaqToc, RegexValidatorDirective, SESSION_TOKEN_KEY, SHELL_APP_NAME, SHELL_AUTH_URLS, SHELL_COMMANDS, SHELL_MENU_ITEMS, SHELL_POST_LOGIN_ROUTE, SHELL_SHARED_SESSION, SessionTokenStore, Shell, SideMenu, StatusBar, TerminalFocusService, TerminalVisibilityService, ThemeService, ThinkingService, audienceAllowed, authGuard, authInterceptor, buildFallbackChain, decideRenewal, guestGuard, matchesRoute, provideShellConfig, tokenize };
 //# sourceMappingURL=franzzemen-brokenstock-shell.mjs.map