@dataengineeringformachinelearning/viking-ui 1.0.2 → 3.0.0-alpha.2

package/src/lib/site-drakkar/site-drakkar.config.ts

@@ -0,0 +1,295 @@
+import { VikingIconName } from "../core/icons";
+
+/**
+ * Drakkar — the Viking longship that carries the site shell (navbar, footer, nav links)
+ * across marketing, app, and backend surfaces.
+ */
+
+/** Which DEML surface the Drakkar shell is rendering on (navbar + footer). */
+export type SiteDrakkarContext = "app" | "marketing" | "backend" | "docs";
+
+export interface SiteUrls {
+  app: string;
+  marketing: string;
+  backend: string;
+}
+
+export interface SiteNavLink {
+  id: string;
+  label: string;
+  icon: VikingIconName;
+  appHref: string;
+  marketingHref: string;
+  external?: boolean;
+  requireAuth?: boolean;
+  /** Routes served by deml.app — resolved to absolute app URLs off-app. */
+  platform?: boolean;
+}
+
+export interface SiteFooterLink {
+  label: string;
+  appHref: string;
+  marketingHref: string;
+  external?: boolean;
+  action?: "cookie-settings" | "bug-report";
+  /** Routes served by deml.app — resolved to absolute app URLs off-app. */
+  platform?: boolean;
+}
+
+export interface SiteFooterColumn {
+  title: string;
+  links: SiteFooterLink[];
+}
+
+/** Primary navbar links (desktop + mobile). Shown on every surface. */
+export const SITE_NAV_LINKS: readonly SiteNavLink[] = [
+  {
+    id: "explore",
+    label: "Explore",
+    icon: "globe",
+    appHref: "/explore",
+    marketingHref: "/explore",
+    platform: true,
+  },
+  {
+    id: "documentation",
+    label: "Documentation",
+    icon: "file",
+    appHref: "https://dataengineeringformachinelearning.com/documentation/",
+    marketingHref: "/documentation",
+  },
+  {
+    id: "dashboard",
+    label: "Dashboard",
+    icon: "home",
+    appHref: "/dashboard",
+    marketingHref: "/dashboard",
+    requireAuth: true,
+    platform: true,
+  },
+  {
+    id: "sites",
+    label: "Sites",
+    icon: "building",
+    appHref: "/settings",
+    marketingHref: "/settings",
+    requireAuth: true,
+    platform: true,
+  },
+  {
+    id: "account",
+    label: "Account",
+    icon: "user",
+    appHref: "/account",
+    marketingHref: "/account",
+    requireAuth: true,
+    platform: true,
+  },
+] as const;
+
+export const SITE_FOOTER_COLUMNS: readonly SiteFooterColumn[] = [
+  {
+    title: "Platform",
+    links: [
+      {
+        label: "Explore",
+        appHref: "/explore",
+        marketingHref: "/explore",
+        platform: true,
+      },
+      {
+        label: "Dashboard",
+        appHref: "/dashboard",
+        marketingHref: "/dashboard",
+        platform: true,
+      },
+      {
+        label: "Sites",
+        appHref: "/settings",
+        marketingHref: "/settings",
+        platform: true,
+      },
+      {
+        label: "Account",
+        appHref: "/account",
+        marketingHref: "/account",
+        platform: true,
+      },
+      {
+        label: "Platform Status",
+        appHref: "/status/platform-status",
+        marketingHref: "/status/platform-status",
+        platform: true,
+      },
+    ],
+  },
+  {
+    title: "Resources",
+    links: [
+      {
+        label: "Documentation",
+        appHref: "https://dataengineeringformachinelearning.com/documentation/",
+        marketingHref: "/documentation",
+      },
+      {
+        label: "Whitepaper",
+        appHref: "https://dataengineeringformachinelearning.com/whitepaper/",
+        marketingHref: "/whitepaper",
+      },
+      {
+        label: "Book",
+        appHref: "https://dataengineeringformachinelearning.com/book/",
+        marketingHref: "/book",
+      },
+    ],
+  },
+  {
+    title: "Support",
+    links: [
+      {
+        label: "Platform Status",
+        appHref: "/status/platform-status",
+        marketingHref: "/status/platform-status",
+        platform: true,
+      },
+      {
+        label: "Report a Bug",
+        appHref: "#",
+        marketingHref: "#",
+        action: "bug-report",
+      },
+    ],
+  },
+  {
+    title: "Legal & Compliance",
+    links: [
+      {
+        label: "Privacy Policy",
+        appHref: "https://dataengineeringformachinelearning.com/privacy/",
+        marketingHref: "/privacy",
+      },
+      {
+        label: "Terms of Service",
+        appHref: "https://dataengineeringformachinelearning.com/terms/",
+        marketingHref: "/terms",
+      },
+      {
+        label: "SOC2 Compliance",
+        appHref: "https://dataengineeringformachinelearning.com/compliance/",
+        marketingHref: "/compliance",
+      },
+      {
+        label: "GDPR Compliance",
+        appHref: "https://dataengineeringformachinelearning.com/privacy/#gdpr",
+        marketingHref: "/privacy#gdpr",
+      },
+      {
+        label: "Cookie Settings",
+        appHref: "#",
+        marketingHref: "#",
+        action: "cookie-settings",
+      },
+    ],
+  },
+] as const;
+
+export const BUG_REPORT_QUERY = "reportBug=1";
+export const COOKIE_SETTINGS_QUERY = "cookieSettings=1";
+
+const isAbsoluteUrl = (href: string): boolean => /^https?:\/\//i.test(href);
+
+const joinBase = (base: string, path: string): string => {
+  if (isAbsoluteUrl(path)) {
+    return path;
+  }
+  const normalizedBase = base.replace(/\/$/, "");
+  const normalizedPath = path.startsWith("/") ? path : `/${path}`;
+  return `${normalizedBase}${normalizedPath}`;
+};
+
+export const bugReportHref = (urls: SiteUrls): string =>
+  `${joinBase(urls.app, "/")}?${BUG_REPORT_QUERY}`;
+
+export const cookieSettingsHref = (urls: SiteUrls): string =>
+  `${joinBase(urls.marketing, "/")}?${COOKIE_SETTINGS_QUERY}`;
+
+const resolveMarketingContentHref = (href: string, urls: SiteUrls): string => {
+  if (isAbsoluteUrl(href)) {
+    return href;
+  }
+  if (href.startsWith("mailto:")) {
+    return href;
+  }
+  return href.startsWith("/") ? href : joinBase(urls.marketing, href);
+};
+
+const resolvePlatformHref = (
+  href: string,
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): string => {
+  if (context === "app") {
+    return href;
+  }
+  return joinBase(urls.app, href);
+};
+
+export const resolveNavHref = (
+  link: SiteNavLink,
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): string => {
+  if (link.platform) {
+    return resolvePlatformHref(link.appHref, context, urls);
+  }
+  if (context === "app") {
+    return link.appHref;
+  }
+  return resolveMarketingContentHref(link.marketingHref, urls);
+};
+
+export const resolveFooterHref = (
+  link: SiteFooterLink,
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): string => {
+  if (link.action === "bug-report") {
+    return context === "app" ? "#" : bugReportHref(urls);
+  }
+  if (link.action === "cookie-settings") {
+    return cookieSettingsHref(urls);
+  }
+  if (link.platform) {
+    return resolvePlatformHref(link.appHref, context, urls);
+  }
+  if (context === "app") {
+    return link.appHref;
+  }
+  return resolveMarketingContentHref(link.marketingHref, urls);
+};
+
+export const resolveBrandHref = (
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): string => {
+  if (context === "marketing") {
+    return "/";
+  }
+  return urls.marketing;
+};
+
+/** Navbar links; auth-gated entries appear only when the session is active. */
+export const visibleNavLinks = (
+  links: readonly SiteNavLink[],
+  isAuthenticated = false,
+): SiteNavLink[] =>
+  links.filter((link) => !link.requireAuth || isAuthenticated);
+
+export const isAppRouterPath = (href: string): boolean =>
+  !isAbsoluteUrl(href) && href.startsWith("/");
+
+export const DEFAULT_SITE_URLS: SiteUrls = {
+  app: "https://deml.app",
+  marketing: "https://dataengineeringformachinelearning.com",
+  backend: "https://backend.deml.app",
+};

package/src/lib/site-drakkar/suite-search-items.ts

@@ -0,0 +1,246 @@
+import type {
+  SiteDrakkarContext,
+  SiteFooterLink,
+  SiteNavLink,
+  SiteUrls,
+} from "./site-drakkar.config";
+import {
+  SITE_FOOTER_COLUMNS,
+  SITE_NAV_LINKS,
+  bugReportHref,
+  cookieSettingsHref,
+  resolveFooterHref,
+  resolveNavHref,
+} from "./site-drakkar.config";
+
+/** Curated command-palette entry for cross-surface navigation. */
+export type SuiteSearchItem = {
+  title: string;
+  href: string;
+  snippet?: string;
+  group?: string;
+  keywords?: string[];
+  action?: "cookie-settings" | "bug-report";
+};
+
+const dedupeItems = (items: SuiteSearchItem[]): SuiteSearchItem[] => {
+  const seen = new Set<string>();
+  return items.filter((item) => {
+    const key = `${item.title}:${item.href}:${item.action ?? ""}`;
+    if (seen.has(key)) {
+      return false;
+    }
+    seen.add(key);
+    return true;
+  });
+};
+
+const navItem = (
+  link: SiteNavLink,
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): SuiteSearchItem => ({
+  title: link.label,
+  href: resolveNavHref(link, context, urls),
+  snippet: `Open ${link.label}`,
+  group: "Platform",
+  keywords: [link.id, link.label.toLowerCase(), "navigate", "go"],
+});
+
+const footerItem = (
+  link: SiteFooterLink,
+  columnTitle: string,
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): SuiteSearchItem => {
+  if (link.action === "cookie-settings") {
+    return {
+      title: link.label,
+      href: cookieSettingsHref(urls),
+      snippet: "Manage analytics and cookie preferences",
+      group: columnTitle,
+      keywords: ["cookies", "consent", "privacy", "gdpr"],
+      action: "cookie-settings",
+    };
+  }
+
+  if (link.action === "bug-report") {
+    return {
+      title: link.label,
+      href: context === "app" ? "#" : bugReportHref(urls),
+      snippet: "Submit a product issue or regression",
+      group: columnTitle,
+      keywords: ["bug", "issue", "support", "feedback"],
+      action: "bug-report",
+    };
+  }
+
+  return {
+    title: link.label,
+    href: resolveFooterHref(link, context, urls),
+    snippet: `Open ${link.label}`,
+    group: columnTitle,
+    keywords: [link.label.toLowerCase(), columnTitle.toLowerCase()],
+  };
+};
+
+/** Static entries that are not derived from Drakkar nav/footer config. */
+const SUITE_SEARCH_EXTRAS: readonly Omit<SuiteSearchItem, "href">[] = [
+  {
+    title: "Viking-UI Components",
+    snippet: "Browse the design system showcase",
+    group: "Resources",
+    keywords: ["viking", "ui", "design system", "components", "showcase"],
+  },
+  {
+    title: "Design tokens",
+    snippet: "Canonical --viking-* token matrix",
+    group: "Resources",
+    keywords: ["tokens", "theme", "css", "variables"],
+  },
+  {
+    title: "API reference",
+    snippet: "OpenAPI schema and REST endpoints",
+    group: "Resources",
+    keywords: ["api", "openapi", "swagger", "rest"],
+  },
+];
+
+const resolveExtraHref = (
+  extra: (typeof SUITE_SEARCH_EXTRAS)[number],
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+): string => {
+  switch (extra.title) {
+    case "Viking-UI Components":
+      return "https://ui.dataengineeringformachinelearning.com/components";
+    case "Design tokens":
+      return "https://ui.dataengineeringformachinelearning.com/tokens";
+    case "API reference":
+      return `${urls.backend.replace(/\/$/, "")}/api/docs`;
+    default:
+      return context === "app" ? urls.app : urls.marketing;
+  }
+};
+
+/** Viking-UI docs site entries (ui.dataengineeringformachinelearning.com). */
+const DOCS_SEARCH_EXTRAS: readonly SuiteSearchItem[] = [
+  {
+    title: "Components",
+    href: "/components",
+    snippet: "Browse all documented primitives",
+    group: "Viking-UI",
+    keywords: ["components", "showcase", "registry"],
+  },
+  {
+    title: "Playground",
+    href: "/playground",
+    snippet: "Live Web Component sandbox",
+    group: "Viking-UI",
+    keywords: ["playground", "sandbox", "demo"],
+  },
+  {
+    title: "Architecture",
+    href: "/architecture",
+    snippet: "CSS + WC + Angular layers",
+    group: "Viking-UI",
+    keywords: ["architecture", "layers", "web component"],
+  },
+  {
+    title: "Design tokens",
+    href: "/tokens",
+    snippet: "Canonical --viking-* token matrix",
+    group: "Viking-UI",
+    keywords: ["tokens", "theme", "css", "variables"],
+  },
+  {
+    title: "Theming",
+    href: "/theming",
+    snippet: "Light/dark mode and sync pipeline",
+    group: "Viking-UI",
+    keywords: ["theming", "dark", "light", "mode"],
+  },
+  {
+    title: "Framework guides",
+    href: "/frameworks",
+    snippet: "Angular, Astro, Django setup",
+    group: "Viking-UI",
+    keywords: ["frameworks", "angular", "astro", "django"],
+  },
+  {
+    title: "Contributing",
+    href: "/contributing",
+    snippet: "Extend the Viking-UI kit",
+    group: "Viking-UI",
+    keywords: ["contributing", "extend", "primitives"],
+  },
+];
+
+const resolveDocsHref = (href: string, docsOrigin: string): string =>
+  href.startsWith("http")
+    ? href
+    : `${docsOrigin.replace(/\/$/, "")}${href.startsWith("/") ? href : `/${href}`}`;
+
+/**
+ * Builds curated command-palette links for deml.app, marketing, backend, and docs.
+ * Used by the static widget and Angular `viking-suite-search-palette`.
+ */
+export const buildSuiteSearchItems = (
+  context: SiteDrakkarContext,
+  urls: SiteUrls,
+  options?: { docsOrigin?: string },
+): SuiteSearchItem[] => {
+  const paletteContext = context === "docs" ? "marketing" : context;
+
+  const items: SuiteSearchItem[] = [
+    ...SITE_NAV_LINKS.map((link) => navItem(link, paletteContext, urls)),
+    ...SITE_FOOTER_COLUMNS.flatMap((column) =>
+      column.links.map((link) =>
+        footerItem(link, column.title, paletteContext, urls),
+      ),
+    ),
+    ...SUITE_SEARCH_EXTRAS.map((extra) => ({
+      ...extra,
+      href: resolveExtraHref(extra, paletteContext, urls),
+    })),
+  ];
+
+  if (context === "app") {
+    items.push(
+      {
+        title: "Settings",
+        href: "/settings",
+        snippet: "Workspace domains, billing, and security",
+        group: "Platform",
+        keywords: ["settings", "sites", "workspace", "configuration"],
+      },
+      {
+        title: "Billing & subscription",
+        href: "/settings/billing",
+        snippet: "Manage plan, invoices, and payment methods",
+        group: "Platform",
+        keywords: ["billing", "stripe", "subscription", "payment"],
+      },
+      {
+        title: "Security settings",
+        href: "/settings/security",
+        snippet: "Keys, sessions, and access controls",
+        group: "Platform",
+        keywords: ["security", "keys", "auth", "rbac"],
+      },
+    );
+  }
+
+  if (context === "docs") {
+    const docsOrigin =
+      options?.docsOrigin ?? "https://ui.dataengineeringformachinelearning.com";
+    items.push(
+      ...DOCS_SEARCH_EXTRAS.map((extra) => ({
+        ...extra,
+        href: resolveDocsHref(extra.href, docsOrigin),
+      })),
+    );
+  }
+
+  return dedupeItems(items);
+};