@franzzemen/brokenstock-shell 0.0.29 → 0.0.30

package/fesm2022/franzzemen-brokenstock-shell.mjs

@@ -12,6 +12,7 @@ import { Marked } from 'marked';
 import { gfmHeadingId } from 'marked-gfm-heading-id';
 import fm from 'front-matter';
 import { NgClass, CommonModule, DOCUMENT, DatePipe } from '@angular/common';
+import { Title, Meta } from '@angular/platform-browser';
 import { z } from 'zod/v4';
 import * as i1 from '@angular/material/icon';
 import { MatIconModule } from '@angular/material/icon';
@@ -1236,19 +1237,38 @@ var faqAuthoringPanel = /*#__PURE__*/Object.freeze({
     FaqAuthoringPanel: FaqAuthoringPanel
 });
 
+/**
+ * Canonical public base URL (no trailing slash) used for OpenGraph,
+ * Twitter, JSON-LD canonical URLs, and sitemap entries on the
+ * public FAQ pages. Default empty string — falls back to relative
+ * `og:url` etc. when unset, which is fine for previewing but
+ * suboptimal for production SEO. Consumer apps should override.
+ */
+const FAQ_PUBLIC_SITE_BASE_URL = new InjectionToken('FAQ_PUBLIC_SITE_BASE_URL', { providedIn: 'root', factory: () => '' });
+const FAQ_PUBLIC_PUBLISHER = new InjectionToken('FAQ_PUBLIC_PUBLISHER', { providedIn: 'root', factory: () => ({ name: '' }) });
+
 /**
  * Public, SEO-targeted FAQ index. Prerendered at build time on the
  * consumer side (e.g. /help in broken-stock). Lists every manifest
  * entry where `audience === 'public' && seoReady === true`, grouped
  * by category and ordered by `order`.
+ *
+ * SEO (E17): sets <title>, meta description, OG, and Twitter tags.
+ * JSON-LD (E18): emits a schema.org CollectionPage referencing
+ * each child entry as an ItemList.
  */
 class PublicFaqIndex {
     constructor() {
         this.loader = inject(FAQ_CONTENT_LOADER);
+        this.title = inject(Title);
+        this.meta = inject(Meta);
+        this.siteBase = inject(FAQ_PUBLIC_SITE_BASE_URL);
+        this.publisher = inject(FAQ_PUBLIC_PUBLISHER);
         this._entries = signal([], ...(ngDevMode ? [{ debugName: "_entries" }] : /* istanbul ignore next */ []));
         this.loading = signal(true, ...(ngDevMode ? [{ debugName: "loading" }] : /* istanbul ignore next */ []));
+        this.visibleEntries = computed(() => this._entries().filter((e) => e.audience === 'public' && e.seoReady), ...(ngDevMode ? [{ debugName: "visibleEntries" }] : /* istanbul ignore next */ []));
         this.groups = computed(() => {
-            const visible = this._entries().filter((e) => e.audience === 'public' && e.seoReady);
+            const visible = this.visibleEntries();
             const byCategory = new Map();
             for (const entry of visible) {
                 const list = byCategory.get(entry.category) ?? [];
@@ -1263,16 +1283,68 @@ class PublicFaqIndex {
             groups.sort((a, b) => a.category.localeCompare(b.category));
             return groups;
         }, ...(ngDevMode ? [{ debugName: "groups" }] : /* istanbul ignore next */ []));
+        this.jsonLd = computed(() => {
+            const entries = this.visibleEntries();
+            if (entries.length === 0)
+                return null;
+            const base = this.siteBase.replace(/\/+$/, '');
+            const indexUrl = `${base}/help`;
+            const ld = {
+                '@context': 'https://schema.org',
+                '@type': 'CollectionPage',
+                name: 'Brokenstock Help',
+                url: indexUrl,
+                mainEntity: {
+                    '@type': 'ItemList',
+                    itemListElement: entries.map((entry, idx) => ({
+                        '@type': 'ListItem',
+                        position: idx + 1,
+                        url: `${base}/help/${entry.file}`,
+                        name: entry.title,
+                    })),
+                },
+            };
+            if (this.publisher.name) {
+                const pub = {
+                    '@type': 'Organization',
+                    name: this.publisher.name,
+                };
+                if (this.publisher.url)
+                    pub['url'] = this.publisher.url;
+                if (this.publisher.logo)
+                    pub['logo'] = this.publisher.logo;
+                ld['publisher'] = pub;
+            }
+            return serializeJsonLd$1(ld);
+        }, ...(ngDevMode ? [{ debugName: "jsonLd" }] : /* istanbul ignore next */ []));
     }
     async ngOnInit() {
         try {
             const manifest = await this.loader.loadManifest();
             this._entries.set(manifest.entries);
+            this.applyMeta();
         }
         finally {
             this.loading.set(false);
         }
     }
+    applyMeta() {
+        const base = this.siteBase.replace(/\/+$/, '');
+        const url = `${base}/help`;
+        const description = 'Documentation and walkthroughs for the Brokenstock trade-journal platform.';
+        this.title.setTitle('Help — Brokenstock');
+        this.meta.updateTag({ name: 'description', content: description });
+        this.meta.updateTag({ property: 'og:type', content: 'website' });
+        this.meta.updateTag({ property: 'og:title', content: 'Help — Brokenstock' });
+        this.meta.updateTag({ property: 'og:description', content: description });
+        this.meta.updateTag({ property: 'og:url', content: url });
+        if (this.publisher.name) {
+            this.meta.updateTag({ property: 'og:site_name', content: this.publisher.name });
+        }
+        this.meta.updateTag({ name: 'twitter:card', content: 'summary' });
+        this.meta.updateTag({ name: 'twitter:title', content: 'Help — Brokenstock' });
+        this.meta.updateTag({ name: 'twitter:description', content: description });
+    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.13", ngImport: i0, type: PublicFaqIndex, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
     static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "21.2.13", type: PublicFaqIndex, isStandalone: true, selector: "public-faq-index", ngImport: i0, template: `
     <article class="public-faq-index">
@@ -1301,6 +1373,9 @@ class PublicFaqIndex {
           </section>
         }
       }
+      @if (jsonLd(); as ld) {
+        <script type="application/ld+json">{{ ld }}</script>
+      }
     </article>
   `, isInline: true, styles: [":host{display:block}.public-faq-index{max-width:860px;margin:0 auto;padding:2rem 1.25rem 4rem;font-family:system-ui,-apple-system,Segoe UI,sans-serif;line-height:1.55}header h1{font-size:2.25rem;margin:0 0 .5rem}.lead{color:#555;margin:0 0 2rem;font-size:1.1rem}h2{font-size:1.35rem;margin:1.75rem 0 .5rem;border-bottom:1px solid #eee;padding-bottom:.25rem}ul{list-style:none;padding:0;margin:0}li{padding:.4rem 0}a{color:#1565c0;text-decoration:none;font-weight:500}a:hover{text-decoration:underline}.desc{color:#666;font-weight:400}\n"], dependencies: [{ kind: "ngmodule", type: CommonModule }, { kind: "directive", type: RouterLink, selector: "[routerLink]", inputs: ["target", "queryParams", "fragment", "queryParamsHandling", "state", "info", "relativeTo", "preserveFragment", "skipLocationChange", "replaceUrl", "routerLink"] }] }); }
 }
@@ -1333,9 +1408,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.13", ngImpo
           </section>
         }
       }
+      @if (jsonLd(); as ld) {
+        <script type="application/ld+json">{{ ld }}</script>
+      }
     </article>
   `, styles: [":host{display:block}.public-faq-index{max-width:860px;margin:0 auto;padding:2rem 1.25rem 4rem;font-family:system-ui,-apple-system,Segoe UI,sans-serif;line-height:1.55}header h1{font-size:2.25rem;margin:0 0 .5rem}.lead{color:#555;margin:0 0 2rem;font-size:1.1rem}h2{font-size:1.35rem;margin:1.75rem 0 .5rem;border-bottom:1px solid #eee;padding-bottom:.25rem}ul{list-style:none;padding:0;margin:0}li{padding:.4rem 0}a{color:#1565c0;text-decoration:none;font-weight:500}a:hover{text-decoration:underline}.desc{color:#666;font-weight:400}\n"] }]
         }] });
+function serializeJsonLd$1(obj) {
+    return JSON.stringify(obj).replace(/</g, '\\u003c');
+}
 
 /**
  * Public, SEO-targeted FAQ page. Prerendered at build time per
@@ -1343,12 +1424,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.13", ngImpo
  *
  * The route is `help/**` so multi-segment file paths work; this
  * component reads the wildcard path off `ActivatedRoute.url`.
+ *
+ * SEO (E17): sets <title>, meta description, OpenGraph and Twitter
+ * Card tags using Angular's Title + Meta services (SSR-compatible).
+ * JSON-LD (E18): emits a schema.org Article (or BlogPosting) object
+ * via an inline <script type="application/ld+json"> element. The
+ * raw JSON has `<` escaped to `<` so a stray `</script>` inside
+ * data won't break the surrounding tag.
  */
 class PublicFaqPage {
     constructor() {
         this.route = inject(ActivatedRoute);
         this.loader = inject(FAQ_CONTENT_LOADER);
         this.renderer = inject(FaqMarkdownRendererService);
+        this.title = inject(Title);
+        this.meta = inject(Meta);
+        this.siteBase = inject(FAQ_PUBLIC_SITE_BASE_URL);
+        this.publisher = inject(FAQ_PUBLIC_PUBLISHER);
         this.entry = signal(null, ...(ngDevMode ? [{ debugName: "entry" }] : /* istanbul ignore next */ []));
         this.body = signal('', ...(ngDevMode ? [{ debugName: "body" }] : /* istanbul ignore next */ []));
         this.loading = signal(true, ...(ngDevMode ? [{ debugName: "loading" }] : /* istanbul ignore next */ []));
@@ -1364,31 +1456,88 @@ class PublicFaqPage {
                     : undefined,
             });
         }, ...(ngDevMode ? [{ debugName: "renderedHtml" }] : /* istanbul ignore next */ []));
+        this.jsonLd = computed(() => {
+            const entry = this.entry();
+            if (!entry)
+                return null;
+            const url = this.canonicalUrl(entry);
+            const ld = {
+                '@context': 'https://schema.org',
+                '@type': 'Article',
+                headline: entry.title,
+                url,
+                mainEntityOfPage: url,
+            };
+            if (entry.description)
+                ld['description'] = entry.description;
+            if (this.publisher.name) {
+                const pub = {
+                    '@type': 'Organization',
+                    name: this.publisher.name,
+                };
+                if (this.publisher.url)
+                    pub['url'] = this.publisher.url;
+                if (this.publisher.logo)
+                    pub['logo'] = this.publisher.logo;
+                ld['publisher'] = pub;
+                ld['author'] = pub;
+            }
+            return serializeJsonLd(ld);
+        }, ...(ngDevMode ? [{ debugName: "jsonLd" }] : /* istanbul ignore next */ []));
     }
     async ngOnInit() {
         try {
             const segments = this.route.snapshot.url.map((s) => s.path);
             const filePath = segments.join('/');
             if (!filePath) {
+                this.applyNotFoundMeta();
                 return;
             }
             const manifest = await this.loader.loadManifest();
-            const match = manifest.entries.find((e) => e.file === filePath &&
-                e.audience === 'public' &&
-                e.seoReady);
-            if (!match)
+            const match = manifest.entries.find((e) => e.file === filePath && e.audience === 'public' && e.seoReady);
+            if (!match) {
+                this.applyNotFoundMeta();
                 return;
+            }
             const content = await this.loader.loadContent(match.key);
-            if (content === null)
+            if (content === null) {
+                this.applyNotFoundMeta();
                 return;
+            }
             const parsed = this.renderer.parse(content);
             this.entry.set(match);
             this.body.set(parsed.body);
+            this.applyMeta(match);
         }
         finally {
             this.loading.set(false);
         }
     }
+    applyMeta(entry) {
+        const url = this.canonicalUrl(entry);
+        const description = entry.description ?? '';
+        const title = `${entry.title} — Help`;
+        this.title.setTitle(title);
+        this.meta.updateTag({ name: 'description', content: description });
+        this.meta.updateTag({ property: 'og:type', content: 'article' });
+        this.meta.updateTag({ property: 'og:title', content: entry.title });
+        this.meta.updateTag({ property: 'og:description', content: description });
+        this.meta.updateTag({ property: 'og:url', content: url });
+        if (this.publisher.name) {
+            this.meta.updateTag({ property: 'og:site_name', content: this.publisher.name });
+        }
+        this.meta.updateTag({ name: 'twitter:card', content: 'summary' });
+        this.meta.updateTag({ name: 'twitter:title', content: entry.title });
+        this.meta.updateTag({ name: 'twitter:description', content: description });
+    }
+    applyNotFoundMeta() {
+        this.title.setTitle('Page not found — Help');
+        this.meta.updateTag({ name: 'robots', content: 'noindex' });
+    }
+    canonicalUrl(entry) {
+        const base = this.siteBase.replace(/\/+$/, '');
+        return `${base}/help/${entry.file}`;
+    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.13", ngImport: i0, type: PublicFaqPage, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
     static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "21.2.13", type: PublicFaqPage, isStandalone: true, selector: "public-faq-page", ngImport: i0, template: `
     <article class="public-faq-page">
@@ -1410,6 +1559,9 @@ class PublicFaqPage {
           }
         </header>
         <div class="body" [innerHTML]="renderedHtml()"></div>
+        @if (jsonLd(); as ld) {
+          <script type="application/ld+json">{{ ld }}</script>
+        }
       }
     </article>
   `, isInline: true, styles: [":host{display:block}.public-faq-page{max-width:860px;margin:0 auto;padding:2rem 1.25rem 4rem;font-family:system-ui,-apple-system,Segoe UI,sans-serif;line-height:1.6}.crumbs{margin-bottom:1.5rem;font-size:.9rem}.crumbs a{color:#1565c0;text-decoration:none}.crumbs a:hover{text-decoration:underline}header h1{font-size:2.1rem;margin:0 0 .5rem}.lead{color:#555;font-size:1.1rem;margin:0 0 1.5rem}.body :is(h1,h2,h3,h4){margin-top:2rem}.body a{color:#1565c0}.body img{max-width:100%;height:auto}.body pre{background:#f6f8fa;padding:.75rem 1rem;border-radius:6px;overflow-x:auto}.body code{background:#f6f8fa;padding:.1rem .3rem;border-radius:3px;font-size:.9em}.body pre code{background:transparent;padding:0}\n"], dependencies: [{ kind: "ngmodule", type: CommonModule }, { kind: "directive", type: RouterLink, selector: "[routerLink]", inputs: ["target", "queryParams", "fragment", "queryParamsHandling", "state", "info", "relativeTo", "preserveFragment", "skipLocationChange", "replaceUrl", "routerLink"] }] }); }
@@ -1436,10 +1588,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.13", ngImpo
           }
         </header>
         <div class="body" [innerHTML]="renderedHtml()"></div>
+        @if (jsonLd(); as ld) {
+          <script type="application/ld+json">{{ ld }}</script>
+        }
       }
     </article>
   `, styles: [":host{display:block}.public-faq-page{max-width:860px;margin:0 auto;padding:2rem 1.25rem 4rem;font-family:system-ui,-apple-system,Segoe UI,sans-serif;line-height:1.6}.crumbs{margin-bottom:1.5rem;font-size:.9rem}.crumbs a{color:#1565c0;text-decoration:none}.crumbs a:hover{text-decoration:underline}header h1{font-size:2.1rem;margin:0 0 .5rem}.lead{color:#555;font-size:1.1rem;margin:0 0 1.5rem}.body :is(h1,h2,h3,h4){margin-top:2rem}.body a{color:#1565c0}.body img{max-width:100%;height:auto}.body pre{background:#f6f8fa;padding:.75rem 1rem;border-radius:6px;overflow-x:auto}.body code{background:#f6f8fa;padding:.1rem .3rem;border-radius:3px;font-size:.9em}.body pre code{background:transparent;padding:0}\n"] }]
         }] });
+/**
+ * Serializes a JSON-LD object for safe inclusion in a
+ * `<script type="application/ld+json">` element. Escapes `<` so a
+ * stray `</script>` inside any string field cannot break out of the
+ * script tag. (Browsers and crawlers parse the resulting `<`
+ * back to `<` per JSON spec.)
+ */
+function serializeJsonLd(obj) {
+    return JSON.stringify(obj).replace(/</g, '\\u003c');
+}
 
 class ThemeService {
     constructor() {
@@ -2253,5 +2418,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.13", ngImpo
  * 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, FaqAuthoringPanel, FaqHistoryService, FaqMarkdownRendererService, FaqModal, FaqService, HELP_USAGE, HttpFaqContentLoader, KeyboardShortcutService, Login, MainContent, PublicFaqIndex, PublicFaqPage, RegexValidatorDirective, SHELL_APP_NAME, SHELL_AUTH_URLS, SHELL_COMMANDS, SHELL_MENU_ITEMS, SHELL_POST_LOGIN_ROUTE, Shell, SideMenu, StatusBar, TerminalFocusService, ThemeService, ThinkingService, audienceAllowed, authGuard, authInterceptor, buildFallbackChain, 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, RegexValidatorDirective, SHELL_APP_NAME, SHELL_AUTH_URLS, SHELL_COMMANDS, SHELL_MENU_ITEMS, SHELL_POST_LOGIN_ROUTE, Shell, SideMenu, StatusBar, TerminalFocusService, ThemeService, ThinkingService, audienceAllowed, authGuard, authInterceptor, buildFallbackChain, guestGuard, provideShellConfig, tokenize };
 //# sourceMappingURL=franzzemen-brokenstock-shell.mjs.map