Track HiveGrid Cloud planning reference

This commit is contained in:
david committed 2026-06-26 20:48:01 +02:00
1 parent b3d5ea6764
commit e341c5938a
5784 files changed
+1104929 -3

No files matched your search

@@ -0,0 +1,166 @@
import { readdirSync, statSync } from "node:fs";
import * as path from "node:path";
import { describe, it, expect, vi } from "vitest";
import { AdminSidebar } from "./AdminSidebar";
import type { SideBarItem } from "./SidebarItem";
import { canonicalAdminRouteSlugs, disabledPluginRouteSlugs } from "~/utils/app/PublicRouteSegments";
import { resolveRepoPath } from "~/utils/testing/repoPaths";
function flattenSidebarItems(items: SideBarItem[]): SideBarItem[] {
return items.flatMap((item) => [item, ...flattenSidebarItems(item.items ?? [])]);
}
function walkRouteFiles(directory: string): string[] {
return readdirSync(directory).flatMap((entry) => {
const absolutePath = path.join(directory, entry);
const stats = statSync(absolutePath);
if (stats.isDirectory()) {
return walkRouteFiles(absolutePath);
}
if (!/\.(tsx?|jsx?)$/.test(entry) || /\.(test|spec)\.(tsx?|jsx?)$/.test(entry) || entry.endsWith(".server.ts")) {
return [];
}
return [absolutePath];
});
}
function routePathFromAdminRouteFile(absolutePath: string): string | null {
const routeRoot = resolveRepoPath("apps/web/app/routes/admin");
const relativePath = path.relative(routeRoot, absolutePath).replace(/\\/g, "/");
if (relativePath === "404.tsx" || relativePath.startsWith("internal/")) {
return null;
}
const withoutExtension = relativePath.replace(/\.(tsx?|jsx?)$/, "");
const parts = withoutExtension
.split("/")
.flatMap((part) => part.split("."))
.filter((part) => part && part !== "index" && !part.startsWith("__"));
return parts.join("/");
}
function collectAdminRoutePaths(): string[] {
return walkRouteFiles(resolveRepoPath("apps/web/app/routes/admin"))
.map(routePathFromAdminRouteFile)
.filter((routePath): routePath is string => routePath !== null);
}
function targetMatchesRoute(target: string, routePath: string): boolean {
const targetParts = target.split("/").filter(Boolean);
const routeParts = routePath.split("/").filter(Boolean);
if (targetParts.length !== routeParts.length) {
return false;
}
return routeParts.every((routePart, index) => routePart.startsWith("$") || routePart === targetParts[index]);
}
function normalizeSidebarPath(pathname: string): string | null {
if (!pathname.startsWith("/") || pathname === "/") {
return null;
}
return pathname.split(/[?#]/)[0]?.replace(/^\/+|\/+$/g, "") || null;
}
describe("AdminSidebar", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
it("returns an array of sidebar items", () => {
const sidebar = AdminSidebar({ t, appConfiguration: null });
const serialized = JSON.stringify(sidebar);
const allPaths = flattenSidebarItems(sidebar)
.map((item) => item.path)
.filter((path): path is string => Boolean(path) && path !== "/" && path.startsWith("/"));
expect(Array.isArray(sidebar)).toBe(true);
expect(serialized).toContain("/dashboard");
expect(serialized).toContain("/accounts");
expect(serialized).toContain("/analytics/overview");
expect(serialized).toContain("/audit-trails");
expect(serialized).toContain("/notifications/messages");
expect(serialized).toContain("/feature-flags/flags");
expect(serialized).toContain("/onboarding/onboardings");
expect(serialized).toContain("/metrics/summary");
expect(serialized).toContain("/settings/profile");
expect(sidebar).toEqual(
expect.arrayContaining([
expect.objectContaining({
items: expect.arrayContaining([
expect.objectContaining({ id: "ui.nav.admin.dashboard", path: "/dashboard" }),
]),
}),
])
);
expect(sidebar.at(-1)?.items).toEqual(
expect.arrayContaining([
expect.objectContaining({ id: "ui.nav.admin.switchToApp", path: "/", exact: true }),
])
);
const emittedPaths = serialized.match(/"path":"[^"]*"/g) ?? [];
expect(emittedPaths.filter((path) => path.includes("/admin/"))).toEqual([]);
expect(serialized).not.toContain("/admin/pages");
expect(serialized).not.toContain("/admin/blog");
expect(serialized).not.toContain("/admin/crons");
expect(serialized).not.toContain("/email-marketing");
expect(serialized).not.toContain("/forms");
expect(serialized).not.toContain("/help-desk");
expect(serialized).not.toContain("/knowledge-base");
expect(serialized).not.toContain("/portals");
expect(serialized).not.toContain("/prompts");
expect(serialized).not.toContain("/workflow-engine");
expect(serialized).not.toContain("\"path\":\"/crm\"");
expect(serialized).not.toContain("ui.nav.admin.crm");
expect(allPaths.map((path) => path.split("/").filter(Boolean)[0])).not.toEqual(expect.arrayContaining([...disabledPluginRouteSlugs]));
expect(allPaths.map((path) => path.split("/").filter(Boolean)[0])).toEqual(expect.arrayContaining(["dashboard", "accounts", "settings"]));
allPaths.forEach((path) => {
expect(canonicalAdminRouteSlugs).toContain(path.split("/").filter(Boolean)[0] as any);
});
sidebar.forEach((item) => {
expect(typeof item.title).toBe("string");
expect(typeof item.path).toBe("string");
if (item.items) {
expect(Array.isArray(item.items)).toBe(true);
item.items.forEach((subItem) => {
expect(typeof subItem.title).toBe("string");
expect(typeof subItem.path).toBe("string");
});
}
});
});
it("only emits canonical admin sidebar paths backed by route files", () => {
const routePaths = collectAdminRoutePaths();
const sidebar = AdminSidebar({
t,
appConfiguration: {
app: {
features: {
tenantApiKeys: true,
},
},
} as any,
});
const sidebarTargets = flattenSidebarItems(sidebar)
.map((item) => item.path)
.filter((pathname): pathname is string => Boolean(pathname))
.map(normalizeSidebarPath)
.filter((pathname): pathname is string => pathname !== null);
expect(sidebarTargets).not.toContain("admin");
expect(sidebarTargets.map((pathname) => pathname.split("/")[0])).not.toEqual(expect.arrayContaining([...disabledPluginRouteSlugs]));
const missingTargets = sidebarTargets.filter((target) => !routePaths.some((routePath) => targetMatchesRoute(target, routePath)));
expect(missingTargets).toEqual([]);
});
});
@@ -0,0 +1,354 @@
import { SideBarItem } from "./SidebarItem";
import { TFunction } from "i18next";
import IconDashboard from "~/components/layouts/icons/IconDashboard";
import MembershipCardIcon from "~/components/ui/icons/MembershipCardIcon";
import { AppConfiguration } from "~/utils/db/appConfiguration.db.server";
import IconSettings from "~/components/layouts/icons/IconSettings";
import IconApp from "~/components/layouts/icons/IconApp";
import IconKeys from "~/components/layouts/icons/IconKeys";
import IconEntities from "~/components/layouts/icons/IconEntities";
import IconAnalytics from "~/components/layouts/icons/IconAnalytics";
import IconDocs from "~/components/layouts/icons/IconDocs";
import IconEmails from "~/components/layouts/icons/IconEmails";
import IconEvents from "~/components/layouts/icons/IconEvents";
import IconFeatureFlags from "~/components/layouts/icons/IconFeatureFlags";
import IconHelpDesk from "~/components/layouts/icons/IconHelpDesk";
import IconMetrics from "~/components/layouts/icons/IconMetrics";
import IconNavigation from "~/components/layouts/icons/IconNavigation";
import IconNotifications from "~/components/layouts/icons/IconNotifications";
import IconOnboarding from "~/components/layouts/icons/IconOnboarding";
import IconPortals from "~/components/layouts/icons/IconPortals";
import IconWorkflows from "~/components/layouts/icons/IconWorkflows";
import { UI_NAV_IDS } from "~/application/ui/uiRegistry";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
import { absoluteAppRootPath, type PublicDomainRoutingConfig } from "~/utils/app/CrossHostUrls";
import { disabledPluginRouteSlugs } from "~/utils/app/PublicRouteSegments";
const adminSidebarPath = (path?: string) => adminPath(path, { mode: "host-aware" });
const rootAppFallbackPath = "/";
const disabledAdminRouteSlugs = new Set<string>(disabledPluginRouteSlugs);
function isAdminRouteEnabled(slug: string) {
return !disabledAdminRouteSlugs.has(slug);
}
function enabledAdminRouteItem(slug: string, item: SideBarItem): SideBarItem[] {
return isAdminRouteEnabled(slug) ? [item] : [];
}
type Props = {
t: TFunction;
appConfiguration: AppConfiguration | null;
routing?: PublicDomainRoutingConfig;
};
export const AdminSidebar = ({ t, appConfiguration, routing }: Props): SideBarItem[] => [
{
id: "ui.nav.admin.primary",
title: "",
path: "",
items: [
{
id: UI_NAV_IDS.adminDashboard,
title: t("app.sidebar.dashboard"),
path: adminSidebarPath("dashboard"),
icon: <IconDashboard />,
},
],
},
{
id: "ui.nav.admin.manage",
title: t("segments.manage"),
icon: <IconDashboard />,
path: "",
items: [
{
id: UI_NAV_IDS.adminAccounts,
title: t("app.sidebar.accountsAndUsers"),
path: adminSidebarPath("accounts"),
icon: <MembershipCardIcon />,
isCollapsible: true,
isActive: false,
items: [
{
id: "ui.nav.admin.accounts.tenants",
title: t("admin.tenants.title"),
path: adminSidebarPath("accounts"),
// icon: SvgIcon.TENANTS,
items: [],
permission: "admin.accounts.view",
},
{
id: "ui.nav.admin.accounts.users",
title: t("models.user.plural"),
path: adminSidebarPath("accounts/users"),
items: [],
permission: "admin.users.view",
},
{
id: "ui.nav.admin.accounts.usageFeatures",
title: t("admin.accounts.usageFeatures"),
path: adminSidebarPath("accounts/subscriptions"),
items: [],
permission: "admin.accounts.view",
},
{
id: "ui.nav.admin.accounts.rolesAndPermissions",
title: t("app.sidebar.rolesAndPermissions"),
path: adminSidebarPath("accounts/roles-and-permissions"),
items: [],
permission: "admin.roles.view",
},
{
id: "ui.nav.admin.accounts.blacklist",
title: t("models.blacklist.object"),
path: adminSidebarPath("accounts/blacklist"),
items: [],
permission: "admin.blacklist.view",
},
{
id: "ui.nav.admin.accounts.ipAddresses",
title: t("models.tenantIpAddress.plural"),
path: adminSidebarPath("accounts/ip-addresses"),
items: [],
permission: "admin.tenantIpAddress.view",
},
],
permission: "admin.accounts.view",
},
{
id: UI_NAV_IDS.adminAnalytics,
title: t("app.sidebar.analytics"),
path: adminSidebarPath("analytics"),
icon: <IconAnalytics />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.analytics.overview", title: t("app.sidebar.overview"), path: adminSidebarPath("analytics/overview"), permission: "admin.analytics.view" },
{ id: "ui.nav.admin.analytics.pageViews", title: t("app.sidebar.pageViews"), path: adminSidebarPath("analytics/page-views"), permission: "admin.analytics.view" },
{ id: "ui.nav.admin.analytics.visitors", title: t("app.sidebar.visitors"), path: adminSidebarPath("analytics/visitors"), permission: "admin.analytics.view" },
{ id: "ui.nav.admin.analytics.events", title: t("models.event.plural"), path: adminSidebarPath("analytics/events"), permission: "admin.analytics.view" },
{ id: "ui.nav.admin.analytics.settings", title: t("app.sidebar.settings"), path: adminSidebarPath("analytics/settings"), permission: "admin.settings.analytics.view" },
],
permission: "admin.analytics.view",
},
{
id: UI_NAV_IDS.adminEvents,
title: t("models.event.plural"),
path: adminSidebarPath("events"),
icon: <IconEvents />,
permission: "admin.events.view",
},
{
id: UI_NAV_IDS.adminAuditTrails,
title: t("app.sidebar.auditTrails"),
path: adminSidebarPath("audit-trails"),
icon: <IconEvents />,
permission: "admin.auditTrails.view",
},
{
id: UI_NAV_IDS.adminNotifications,
title: t("app.sidebar.notifications"),
path: adminSidebarPath("notifications"),
icon: <IconNotifications />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.notifications.messages", title: t("app.sidebar.messages"), path: adminSidebarPath("notifications/messages"), permission: "admin.notifications.view" },
{ id: "ui.nav.admin.notifications.channels", title: t("app.sidebar.channels"), path: adminSidebarPath("notifications/channels"), permission: "admin.notifications.view" },
{ id: "ui.nav.admin.notifications.subscribers", title: t("app.sidebar.subscribers"), path: adminSidebarPath("notifications/subscribers"), permission: "admin.notifications.view" },
],
permission: "admin.notifications.view",
},
],
},
{
id: "ui.nav.admin.build",
title: t("segments.build"),
path: "",
items: [
{
id: UI_NAV_IDS.adminEntities,
title: t("models.entity.plural"),
path: adminSidebarPath("entities"),
icon: <IconEntities />,
permission: "admin.entities.view",
},
...enabledAdminRouteItem("workflow-engine", {
id: UI_NAV_IDS.adminWorkflows,
title: t("models.workflow.plural"),
path: adminSidebarPath("workflow-engine"),
icon: <IconWorkflows />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.workflows.workflows", title: t("models.workflow.plural"), path: adminSidebarPath("workflow-engine/workflows") },
{ id: "ui.nav.admin.workflows.executions", title: t("app.sidebar.executions"), path: adminSidebarPath("workflow-engine/executions") },
{ id: "ui.nav.admin.workflows.templates", title: t("models.entity.templates"), path: adminSidebarPath("workflow-engine/templates") },
{ id: "ui.nav.admin.workflows.credentials", title: t("app.sidebar.credentials"), path: adminSidebarPath("workflow-engine/credentials") },
{ id: "ui.nav.admin.workflows.variables", title: t("app.sidebar.variables"), path: adminSidebarPath("workflow-engine/variables") },
],
}),
{
id: UI_NAV_IDS.adminApi,
title: t("settings.api.title"),
path: adminSidebarPath("api"),
icon: <IconKeys />,
permission: "admin.apiKeys.view",
hidden: !appConfiguration?.app.features.tenantApiKeys,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.api.keys", title: t("app.sidebar.apiKeys"), path: adminSidebarPath("api/keys"), permission: "admin.apiKeys.view" },
{ id: "ui.nav.admin.api.logs", title: t("app.sidebar.logs"), path: adminSidebarPath("api/logs"), permission: "admin.apiKeys.view" },
{ id: "ui.nav.admin.api.docs", title: t("app.sidebar.docs"), path: adminSidebarPath("api/docs"), permission: "admin.apiKeys.view" },
{ id: "ui.nav.admin.api.credits", title: t("app.sidebar.credits"), path: adminSidebarPath("api/credits"), permission: "admin.apiKeys.view" },
],
},
{
id: UI_NAV_IDS.adminFeatureFlags,
title: t("app.sidebar.featureFlags"),
path: adminSidebarPath("feature-flags"),
icon: <IconFeatureFlags />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.featureFlags.flags", title: t("app.sidebar.flags"), path: adminSidebarPath("feature-flags/flags"), permission: "admin.featureFlags.view" },
{ id: "ui.nav.admin.featureFlags.settings", title: t("app.sidebar.settings"), path: adminSidebarPath("feature-flags/settings"), permission: "admin.featureFlags.view" },
],
permission: "admin.featureFlags.view",
},
{
id: UI_NAV_IDS.adminNavigation,
title: t("admin.navigation.title"),
path: adminSidebarPath("navigation"),
icon: <IconNavigation className="size-4" />,
},
...enabledAdminRouteItem("portals", {
id: UI_NAV_IDS.adminPortals,
title: t("app.sidebar.portals"),
path: adminSidebarPath("portals"),
icon: <IconPortals />,
}),
],
},
{
id: "ui.nav.admin.market",
title: t("segments.market"),
path: "",
items: [
...enabledAdminRouteItem("email-marketing", {
id: UI_NAV_IDS.adminEmailMarketing,
title: t("app.sidebar.emailMarketing"),
path: adminSidebarPath("email-marketing"),
icon: <IconEmails />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.emailMarketing.campaigns", title: t("app.sidebar.campaigns"), path: adminSidebarPath("email-marketing/campaigns"), permission: "admin.emails.view" },
{ id: "ui.nav.admin.emailMarketing.senders", title: t("app.sidebar.senders"), path: adminSidebarPath("email-marketing/senders"), permission: "admin.emails.view" },
{ id: "ui.nav.admin.emailMarketing.activity", title: t("app.sidebar.activity"), path: adminSidebarPath("email-marketing/activity"), permission: "admin.emails.view" },
],
permission: "admin.emails.view",
}),
{
id: UI_NAV_IDS.adminMarketing,
title: t("app.sidebar.marketing"),
path: adminSidebarPath("marketing-leads"),
icon: <IconAnalytics />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.marketing.leads", title: t("app.sidebar.leads"), path: adminSidebarPath("marketing-leads"), permission: "admin.marketing.leads.view" },
{ id: "ui.nav.admin.marketing.funnels", title: t("app.sidebar.funnels"), path: adminSidebarPath("marketing-funnels"), permission: "admin.marketing.funnels.view" },
{ id: "ui.nav.admin.marketing.integrations", title: t("app.sidebar.integrations"), path: adminSidebarPath("marketing-integrations"), permission: "admin.marketing.integrations.view" },
{ id: "ui.nav.admin.marketing.emailSequences", title: t("app.sidebar.emailSequences"), path: adminSidebarPath("email-sequences"), permission: "admin.marketing.leads.view" },
],
permission: "admin.marketing.leads.view",
},
...enabledAdminRouteItem("knowledge-base", {
id: UI_NAV_IDS.adminKnowledgeBase,
title: t("app.sidebar.knowledgeBase"),
path: adminSidebarPath("knowledge-base"),
icon: <IconDocs className="size-4" />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.knowledgeBase.bases", title: t("app.sidebar.bases"), path: adminSidebarPath("knowledge-base/bases"), permission: "admin.kb.view" },
{ id: "ui.nav.admin.knowledgeBase.articles", title: t("app.sidebar.articles"), path: adminSidebarPath("knowledge-base/articles"), permission: "admin.kb.view" },
],
permission: "admin.kb.view",
}),
...enabledAdminRouteItem("help-desk", {
id: UI_NAV_IDS.adminHelpDesk,
title: t("app.sidebar.helpDesk"),
path: adminSidebarPath("help-desk"),
icon: <IconHelpDesk className="size-4" />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.helpDesk.feedback", title: t("app.sidebar.feedback"), path: adminSidebarPath("help-desk/feedback") },
],
}),
{
id: UI_NAV_IDS.adminOnboarding,
title: t("app.sidebar.onboarding"),
path: adminSidebarPath("onboarding"),
icon: <IconOnboarding />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.onboarding.onboardings", title: t("app.sidebar.onboardings"), path: adminSidebarPath("onboarding/onboardings"), permission: "admin.onboarding.view" },
{ id: "ui.nav.admin.onboarding.sessions", title: t("app.sidebar.sessions"), path: adminSidebarPath("onboarding/sessions"), permission: "admin.onboarding.view" },
],
permission: "admin.onboarding.view",
},
{
id: UI_NAV_IDS.adminMetrics,
title: t("app.sidebar.metrics"),
path: adminSidebarPath("metrics"),
icon: <IconMetrics />,
isCollapsible: true,
items: [
{ id: "ui.nav.admin.metrics.summary", title: t("app.sidebar.summary"), path: adminSidebarPath("metrics/summary"), permission: "admin.metrics.view" },
{ id: "ui.nav.admin.metrics.logs", title: t("app.sidebar.logs"), path: adminSidebarPath("metrics/logs"), permission: "admin.metrics.view" },
{ id: "ui.nav.admin.metrics.settings", title: t("app.sidebar.settings"), path: adminSidebarPath("metrics/settings"), permission: "admin.metrics.view" },
],
permission: "admin.metrics.view",
},
],
},
{
id: "ui.nav.admin.secondary",
title: "",
path: "",
// isSecondary: true,
items: [
{
id: UI_NAV_IDS.adminSettings,
title: t("app.sidebar.settings"),
icon: <IconSettings />,
path: adminSidebarPath("settings"),
isCollapsible: true,
items: [
{ id: "ui.nav.admin.settings.profile", title: t("settings.admin.profile.title"), path: adminSidebarPath("settings/profile") },
{ id: "ui.nav.admin.settings.general", title: t("settings.admin.general.title"), path: adminSidebarPath("settings/general"), permission: "admin.settings.general.view" },
{ id: "ui.nav.admin.settings.pricing", title: t("settings.admin.pricing.title"), path: adminSidebarPath("settings/pricing"), permission: "admin.pricing.view" },
{
id: "ui.nav.admin.settings.authentication",
title: t("settings.admin.authentication.title"),
path: adminSidebarPath("settings/authentication"),
permission: "admin.settings.authentication.view",
},
{ id: "ui.nav.admin.settings.analytics", title: t("settings.admin.analytics.title"), path: adminSidebarPath("settings/analytics"), permission: "admin.settings.analytics.view" },
{
id: "ui.nav.admin.settings.transactionalEmails",
title: t("settings.admin.transactionalEmails.title"),
path: adminSidebarPath("settings/transactional-emails"),
permission: "admin.emails.view",
},
{ id: "ui.nav.admin.settings.accountTypes", title: t("settings.admin.tenants.types.title"), path: adminSidebarPath("settings/accounts/types"), permission: "admin.accountTypes.view" },
{ id: "ui.nav.admin.settings.cookies", title: t("settings.admin.cookies.title"), path: adminSidebarPath("settings/cookies"), permission: "admin.settings.cookies.view" },
{ id: "ui.nav.admin.settings.cache", title: t("settings.admin.cache.title"), path: adminSidebarPath("settings/cache"), permission: "admin.settings.general.update" },
],
},
{
id: UI_NAV_IDS.adminSwitchToApp,
title: t("admin.switchToApp"),
path: routing ? absoluteAppRootPath(routing) : rootAppFallbackPath,
icon: <IconApp />,
exact: true,
},
],
},
];
@@ -0,0 +1,231 @@
import { existsSync } from "node:fs";
import { vi, describe, it, expect } from "vitest";
import { AppSidebar } from "./AppSidebar";
import { UI_NAV_IDS } from "~/application/ui/uiRegistry";
import { EntitySimple } from "~/utils/db/entities/entities.db.server";
import { resolveRepoPath } from "~/utils/testing/repoPaths";
describe("AppSidebar", () => {
const starterProductAccess = {
"crm-basic": { allowed: true },
"email-marketing": { allowed: false },
api: { allowed: false },
"workflow-engine": { allowed: false },
"ai-credits": { allowed: true },
};
const proProductAccess = {
"crm-basic": { allowed: true },
"email-marketing": { allowed: true },
api: { allowed: true },
"workflow-engine": { allowed: false },
"ai-credits": { allowed: true },
};
const businessProductAccess = {
"crm-basic": { allowed: true },
"email-marketing": { allowed: true },
api: { allowed: true },
"workflow-engine": { allowed: true },
"ai-credits": { allowed: true },
};
it("returns the expected sidebar items", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
const i18n = { exists: vi.fn().mockReturnValue(false) } as any;
const entities = [
{ name: "entity1", slug: "entity1", titlePlural: "Entity 1", showInSidebar: true, icon: "" },
{ name: "entity2", slug: "entity2", titlePlural: "Entity 2", showInSidebar: false, icon: "" },
{ name: "entity3", slug: "entity3", titlePlural: "Entity 3", showInSidebar: true, icon: "" },
] as EntitySimple[];
const result = AppSidebar({ t, i18n, tenantId: "test-user", entities, entityGroups: [], appConfiguration: null });
const serialized = JSON.stringify(result);
expect(result[0]).toMatchObject({
title: "",
path: "",
items: [
expect.objectContaining({
id: "ui.nav.app.dashboard",
title: "app.sidebar.dashboard",
path: "/test-user/dashboard",
}),
expect.objectContaining({
id: UI_NAV_IDS.appNotifications,
title: "app.sidebar.notifications",
path: "/test-user/notifications",
}),
expect.objectContaining({
id: "ui.nav.app.entity.entity1",
title: "Entity 1",
path: "/test-user/entity1",
permission: "entity.entity1.view",
}),
expect.objectContaining({
id: "ui.nav.app.entity.entity3",
title: "Entity 3",
path: "/test-user/entity3",
permission: "entity.entity3.view",
}),
],
});
expect(result[1]).toMatchObject({
title: "",
path: "",
isSecondary: true,
items: [
expect.objectContaining({
id: "ui.nav.app.settings",
title: "app.sidebar.settings",
path: "/test-user/settings",
redirectTo: "/test-user/settings/profile",
}),
expect.objectContaining({
id: "ui.nav.app.switchToAdmin",
title: "admin.switchToAdmin",
path: "/dashboard",
adminOnly: true,
}),
],
});
expect(serialized).not.toContain("/app/");
expect(serialized).not.toContain("/admin/");
expect(serialized).not.toContain("/blog");
expect(serialized).not.toContain("/pricing");
expect(serialized).not.toContain("/email-marketing");
expect(serialized).not.toContain("/workflow-engine");
expect(serialized).not.toContain("/widgets");
expect(serialized).not.toContain("/portals");
expect(serialized).not.toContain("/sites/");
});
it("renders plan-backed core feature links from product access decisions", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
const i18n = { exists: vi.fn().mockReturnValue(false) } as any;
const starter = JSON.stringify(
AppSidebar({ t, i18n, tenantId: "starter", entities: [], entityGroups: [], appConfiguration: null, productAccess: starterProductAccess })
);
const pro = JSON.stringify(
AppSidebar({ t, i18n, tenantId: "pro", entities: [], entityGroups: [], appConfiguration: null, productAccess: proProductAccess })
);
const business = JSON.stringify(
AppSidebar({ t, i18n, tenantId: "business", entities: [], entityGroups: [], appConfiguration: null, productAccess: businessProductAccess })
);
expect(starter).toContain("/starter/crm");
expect(starter).toContain("/starter/settings/credits");
expect(starter).not.toContain("/starter/email-marketing");
expect(starter).not.toContain("/starter/settings/api");
expect(starter).not.toContain("/starter/workflow-engine");
expect(pro).toContain("/pro/crm");
expect(pro).toContain("/pro/email-marketing");
expect(pro).toContain("/pro/settings/api");
expect(pro).not.toContain("/pro/workflow-engine");
expect(business).toContain("/business/crm");
expect(business).toContain("/business/email-marketing");
expect(business).toContain("/business/settings/api");
expect(business).toContain("/business/workflow-engine");
});
it("marks collapsible entity groups as expand-only parents", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
const i18n = { exists: vi.fn().mockReturnValue(false) } as any;
const entities = [
{ name: "company", slug: "companies", titlePlural: "Companies", showInSidebar: true, icon: "" },
] as EntitySimple[];
const result = AppSidebar({
t,
i18n,
tenantId: "acme",
entities: [],
entityGroups: [
{
slug: "sales",
title: "Sales",
icon: "",
collapsible: true,
section: null,
entities: [{ entity: entities[0] }],
},
] as any,
appConfiguration: null,
});
const group = result[0].items?.find((item) => item.id === "ui.nav.app.entityGroup.sales");
expect(group).toMatchObject({
isCollapsible: true,
path: "/acme/g/sales",
});
expect(group?.items?.[0]).toMatchObject({ title: "shared.overview", path: "/acme/g/sales" });
});
it("translates DB-backed labels only when locale keys exist", () => {
const t = vi.fn().mockImplementation((v: string) => `translated:${v}`) as any;
const i18n = { exists: vi.fn().mockImplementation((value: string) => value === "models.contact.plural" || value === "groups.sales") } as any;
const entities = [
{ name: "contact", slug: "contacts", titlePlural: "models.contact.plural", showInSidebar: true, icon: "" },
{ name: "custom", slug: "custom", titlePlural: "Custom records", showInSidebar: true, icon: "" },
] as EntitySimple[];
const result = AppSidebar({
t,
i18n,
tenantId: "acme",
entities,
entityGroups: [
{
slug: "sales",
title: "groups.sales",
icon: "",
collapsible: true,
section: null,
entities: [{ entity: entities[0] }],
},
] as any,
appConfiguration: null,
});
const serialized = JSON.stringify(result);
expect(serialized).toContain("translated:models.contact.plural");
expect(serialized).toContain("translated:groups.sales");
expect(serialized).toContain("Custom records");
expect(serialized).not.toContain('"models.contact.plural"');
expect(serialized).not.toContain('"groups.sales"');
});
it("keeps static tenant sidebar targets backed by registered route files", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
const i18n = { exists: vi.fn().mockReturnValue(false) } as any;
const result = AppSidebar({ t, i18n, tenantId: "acme", entities: [], entityGroups: [], appConfiguration: null, productAccess: businessProductAccess });
const serialized = JSON.stringify(result);
expect(serialized).toContain("/acme/dashboard");
expect(serialized).toContain("/acme/notifications");
expect(serialized).toContain("/acme/crm");
expect(serialized).toContain("/acme/email-marketing");
expect(serialized).toContain("/acme/workflow-engine");
expect(serialized).toContain("/acme/settings/api");
expect(serialized).toContain("/acme/settings/credits");
expect(serialized).toContain("/acme/settings");
expect(serialized).toContain("/acme/settings/profile");
expect(serialized).not.toContain("/app/");
expect(serialized).not.toContain("/admin/");
[
"apps/web/app/routes/app.$tenant/dashboard.tsx",
"apps/web/app/routes/app.$tenant/notifications.tsx",
"apps/web/app/routes/app.$tenant/crm.tsx",
"apps/web/app/routes/app.$tenant/email-marketing.tsx",
"apps/web/app/routes/app.$tenant/__workflows/workflow-engine.tsx",
"apps/web/app/routes/app.$tenant/settings/api/index.tsx",
"apps/web/app/routes/app.$tenant/settings/credits.tsx",
"apps/web/app/routes/app.$tenant/settings.tsx",
"apps/web/app/routes/app.$tenant/settings/profile.tsx",
].forEach((routeFile) => {
expect(existsSync(resolveRepoPath(routeFile))).toBe(true);
});
});
});
@@ -0,0 +1,269 @@
import { SideBarItem } from "./SidebarItem";
import { EntitySimple } from "~/utils/db/entities/entities.db.server";
import { TFunction, type i18n as I18n } from "i18next";
import { EntityGroupWithDetails } from "~/utils/db/entities/entityGroups.db.server";
import { AppConfiguration } from "~/utils/db/appConfiguration.db.server";
import IconSettings from "~/components/layouts/icons/IconSettings";
import IconDashboard from "~/components/layouts/icons/IconDashboard";
import IconAdmin from "~/components/layouts/icons/IconAdmin";
import IconNotifications from "~/components/layouts/icons/IconNotifications";
import IconEmails from "~/components/layouts/icons/IconEmails";
import IconKeys from "~/components/layouts/icons/IconKeys";
import IconWorkflows from "~/components/layouts/icons/IconWorkflows";
import CreditsIcon from "~/components/ui/icons/CreditsIcon";
import AddressBookIcon from "~/components/ui/icons/crm/AddressBookIcon";
import IconDocs from "~/components/layouts/icons/IconDocs";
import ViewListIcon from "~/components/ui/icons/ViewListIcon";
import { UI_ID_PATTERNS, UI_NAV_IDS, uiIdSegment } from "~/application/ui/uiRegistry";
import { appPath } from "~/utils/app/CanonicalUrlUtils";
import { absoluteAdminPath, type PublicDomainRoutingConfig } from "~/utils/app/CrossHostUrls";
import { getEntityPermission } from "~/utils/helpers/PermissionsHelper";
import { translateLabel } from "~/utils/i18n/translateLabel";
import { resolveConnectorNavState } from "~/utils/connector/connectorNavState";
import { WALKING_SKELETON_MODULE_KEY } from "~/modules/walkingSkeleton/constants";
type Props = {
t: TFunction;
i18n: I18n;
tenantId: string;
entities: EntitySimple[];
entityGroups: EntityGroupWithDetails[];
appConfiguration: AppConfiguration | null;
routing?: PublicDomainRoutingConfig;
productAccess?: Record<string, { allowed: boolean; reason?: string }>;
};
export const AppSidebar = ({ t, i18n, tenantId, entities, entityGroups, routing, productAccess }: Props): SideBarItem[] => {
const tenantPath = (path?: string) => appPath({ tenantSlug: tenantId, path, mode: "host-aware" });
const hasFeatureAccess = (featureKey: string) => productAccess?.[featureKey]?.allowed === true;
// R-P1c Konnektor-Demo: Walking-Skeleton-Eintrag zeigt die drei Gate-Zustaende (aktiv/gesperrt/ausgeblendet).
const walkingSkeletonDecision = productAccess?.[WALKING_SKELETON_MODULE_KEY];
const walkingSkeletonState = walkingSkeletonDecision ? resolveConnectorNavState(walkingSkeletonDecision) : "hidden";
const sectionItems: SideBarItem[] = [];
const entitiesItems: SideBarItem[] = [];
const productCoreItems: SideBarItem[] = [
...(hasFeatureAccess("crm-basic")
? [
{
id: UI_NAV_IDS.appCrm,
title: t("crm:title"),
path: tenantPath("crm"),
icon: <AddressBookIcon />,
},
]
: []),
...(hasFeatureAccess("files")
? [
{
id: "ui.nav.app.files",
title: t("files.nav.title"),
path: tenantPath("files"),
icon: <IconDocs />,
permission: "files.read_own" as const,
},
]
: []),
...(hasFeatureAccess("tasks")
? [
{
id: "ui.nav.app.tasks",
title: t("tasks.nav.title"),
path: tenantPath("tasks"),
icon: <ViewListIcon />,
permission: "tasks.read_own" as const,
},
]
: []),
...(hasFeatureAccess("email-marketing")
? [
{
id: UI_NAV_IDS.appEmailMarketing,
title: t("emailMarketing:title"),
path: tenantPath("email-marketing"),
icon: <IconEmails />,
},
]
: []),
...(hasFeatureAccess("workflow-engine")
? [
{
id: UI_NAV_IDS.appWorkflowEngine,
title: t("workflows.title"),
path: tenantPath("workflow-engine"),
icon: <IconWorkflows />,
},
]
: []),
...(hasFeatureAccess("api")
? [
{
id: UI_NAV_IDS.appApi,
title: t("models.apiKey.plural"),
path: tenantPath("settings/api"),
icon: <IconKeys />,
},
]
: []),
...(hasFeatureAccess("ai-credits")
? [
{
id: UI_NAV_IDS.appCredits,
title: t("models.credit.plural"),
path: tenantPath("settings/credits"),
icon: <CreditsIcon />,
},
]
: []),
...(walkingSkeletonState !== "hidden"
? [
{
id: "ui.nav.app.walkingSkeleton",
title: t("walkingSkeleton.nav"),
path: tenantPath("walking-skeleton"),
icon: <IconDashboard />,
disabled: walkingSkeletonState === "locked",
},
]
: []),
];
entityGroups.forEach((group) => {
const item: SideBarItem = {
id: `ui.nav.app.entityGroup.${uiIdSegment(group.slug)}`,
uiIdPattern: UI_ID_PATTERNS.appEntityGroup,
uiIdParams: { groupSlug: group.slug },
title: translateLabel(t, i18n, group.title),
// icon: group.icon,
path: tenantPath(`g/${group.slug}`),
icon: group.icon,
// isActive: true,
};
if (group.collapsible) {
item.isCollapsible = true;
item.items = [
{
id: `ui.nav.app.entityGroup.${uiIdSegment(group.slug)}.overview`,
title: t("shared.overview"),
path: tenantPath(`g/${group.slug}`),
},
...group.entities.map(({ entity }) => {
return {
id: `ui.nav.app.entityGroup.${uiIdSegment(group.slug)}.entity.${uiIdSegment(entity.slug)}`,
uiIdPattern: UI_ID_PATTERNS.appEntityGroupEntity,
uiIdParams: { groupSlug: group.slug, entityName: entity.name ?? entity.slug },
title: translateLabel(t, i18n, entity.titlePlural),
// icon: entity.icon,
path: tenantPath(`g/${group.slug}/${entity.slug}`),
permission: getEntityPermission(entity, "view"),
// entityIcon: entity.icon,
};
}),
];
}
if (group.section) {
const sectionTitle = translateLabel(t, i18n, group.section);
const section = sectionItems.find((f) => f.title === sectionTitle);
if (section) {
section.items = [...(section.items ?? []), item];
} else {
sectionItems.push({
id: `ui.nav.app.section.${uiIdSegment(group.section)}`,
uiIdPattern: UI_ID_PATTERNS.appSection,
uiIdParams: { sectionName: group.section },
title: sectionTitle,
path: ``,
items: [item],
});
}
} else {
entitiesItems.push(item);
}
});
entities
.filter((f) => f.showInSidebar)
.forEach((entity) => {
entitiesItems.push({
id: `ui.nav.app.entity.${uiIdSegment(entity.slug)}`,
uiIdPattern: UI_ID_PATTERNS.appEntity,
uiIdParams: { entityName: entity.name ?? entity.slug, entitySlug: entity.slug },
title: translateLabel(t, i18n, entity.titlePlural),
icon: entity.icon,
// tenantUserTypes: [TenantUserType.OWNER, TenantUserType.ADMIN],
path: tenantPath(entity.slug),
permission: getEntityPermission(entity, "view"),
// side: isDebugMode && SideText({ text: modelProperties.length > 0 ? "DB Model" : "Custom" }),
});
});
const appItem: SideBarItem = {
id: "ui.nav.app.primary",
title: "",
path: "",
items: [
{
id: UI_NAV_IDS.appDashboard,
title: t("app.sidebar.dashboard"),
path: tenantPath("dashboard"),
icon: <IconDashboard />,
// tenantUserTypes: [TenantUserType.OWNER, TenantUserType.ADMIN, TenantUserType.MEMBER],
},
{
id: UI_NAV_IDS.appNotifications,
title: t("app.sidebar.notifications"),
path: tenantPath("notifications"),
icon: <IconNotifications />,
},
...productCoreItems,
...entitiesItems,
// {
// title: t("models.email.plural"),
// path: `${currentTenantUrl}/emails`,
// icon: SvgIcon.EMAILS,
// },
],
};
return [
appItem,
...sectionItems,
{
id: "ui.nav.app.secondary",
title: "",
path: "",
isSecondary: true,
items: [
{
id: UI_NAV_IDS.appSettings,
title: t("app.sidebar.settings"),
icon: <IconSettings />,
// tenantUserTypes: [TenantUserType.OWNER, TenantUserType.ADMIN],
path: tenantPath("settings"),
redirectTo: tenantPath("settings/profile"),
},
// {
// title: t("app.sidebar.logs"),
// icon: SvgIcon.LOGS,
// tenantUserTypes: [TenantUserType.OWNER, TenantUserType.ADMIN],
// path: `${currentTenantUrl}/logs`,
// },
{
id: UI_NAV_IDS.appSwitchToAdmin,
title: t("admin.switchToAdmin"),
path: absoluteAdminPath(routing, "dashboard"),
icon: <IconAdmin />,
adminOnly: true,
},
],
},
];
};
// function SideText({ text }: { text: string }) {
// return (
// <div className="inline-flex justify-center space-x-1 items-center px-1.5 py-0.5 rounded-sm text-xs font-medium bg-yellow-100 text-yellow-900 italic truncate w-20">
// <div className="truncate">{text}</div>
// </div>
// );
// }
@@ -0,0 +1,57 @@
import { readFileSync } from "node:fs";
import { join } from "node:path";
import { DocsSidebar } from "./DocsSidebar";
import { SideBarItem } from "./SidebarItem";
describe("DocsSidebar", () => {
it("should return an array of SideBarItem objects", () => {
const docsSidebar: SideBarItem[] = DocsSidebar();
expect(Array.isArray(docsSidebar)).toBe(true);
docsSidebar.forEach((item) => {
expect(typeof item.title).toBe("string");
expect(typeof item.path).toBe("string");
if (item.items) {
expect(Array.isArray(item.items)).toBe(true);
item.items.forEach((subItem) => {
expect(typeof subItem.title).toBe("string");
expect(typeof subItem.path).toBe("string");
});
}
});
});
it("should return feature items with tab titles starting with capital letters", () => {
const docsSidebar: SideBarItem[] = DocsSidebar();
const pageBlockItem = docsSidebar[2];
const pageBlockTab = pageBlockItem.items?.find((item) => item.path === "/docs/features");
expect(pageBlockTab).toBeDefined();
expect(pageBlockTab?.title).toMatch(/^\w/);
expect(pageBlockTab?.title.charAt(0)).toMatch(/[A-Z]/);
});
it("does not expose removed marketing docs in the default navigation", () => {
const serialized = JSON.stringify(DocsSidebar());
expect(serialized).not.toContain(["/docs/page", "-blocks"].join(""));
expect(serialized).not.toContain("/docs/features/marketing");
expect(serialized).not.toContain("/docs/features/email-marketing");
expect(serialized).not.toContain("/docs/features/help-desk");
expect(serialized).not.toContain("/docs/features/knowledge-base");
expect(serialized).not.toContain("/docs/features/analytics");
expect(serialized).not.toContain("/docs/features/onboarding");
expect(serialized).not.toContain("/docs/learning-center/guides/branding/landing");
expect(serialized).not.toContain("🚀");
expect(serialized).not.toContain("🚧");
});
it("uses semantic docs sidebar translation keys", () => {
const source = readFileSync(join(process.cwd(), "apps/web/app/application/sidebar/DocsSidebar.ts"), "utf8");
expect(source).toContain("docs.sidebar.introduction");
expect(source).toContain("docs.sidebar.learningCenter");
expect(source).toContain("docs.sidebar.coreModels");
expect(source.match(/^\s*title:\s*"(?!")/gmu)).toBeNull();
expect(source).not.toContain("ui.autogenerated");
});
});
@@ -0,0 +1,407 @@
import { SideBarItem } from "./SidebarItem";
import { t as i18nT } from "i18next";
import { UI_ID_PATTERNS, UI_NAV_IDS, uiIdSegment } from "~/application/ui/uiRegistry";
function withDocsSidebarIds(items: SideBarItem[], seenIds = new Map<string, number>()): SideBarItem[] {
return items.map((item) => {
const baseId = item.id ?? (item.path ? `ui.nav.docs.${uiIdSegment(item.path.replace(/^\/docs\/?/, "") || "index")}` : `ui.nav.docs.group.${uiIdSegment(item.title)}`);
const seenCount = seenIds.get(baseId) ?? 0;
seenIds.set(baseId, seenCount + 1);
const id = seenCount === 0 ? baseId : `${baseId}.${seenCount + 1}`;
return {
...item,
id,
uiIdPattern: item.uiIdPattern ?? (item.path ? UI_ID_PATTERNS.docsRoute : undefined),
uiIdParams: item.uiIdParams ?? (item.path ? { routeSlug: item.path.replace(/^\/docs\/?/, "") || "index" } : undefined),
items: item.items ? withDocsSidebarIds(item.items, seenIds) : item.items,
};
});
}
export const DocsSidebar = (): SideBarItem[] => {
return withDocsSidebarIds([
{
id: "ui.nav.docs.primary",
title: "",
path: "/docs",
exact: true,
items: [
{
id: UI_NAV_IDS.docsIntroduction,
title: i18nT("docs.sidebar.introduction"),
path: "/docs",
exact: true,
},
],
},
{
id: "ui.nav.docs.gettingStarted",
title: i18nT("docs.sidebar.gettingStarted"),
path: "",
items: [
{
title: i18nT("docs.sidebar.stack"),
path: "/docs/stack",
},
// {
// title: "Code structure",
// path: "/docs/code-structure",
//
// },
{
title: i18nT("docs.sidebar.roadmap"),
path: "/docs/roadmap",
},
{
title: i18nT("docs.sidebar.license"),
path: "/docs/license",
},
{
title: i18nT("docs.sidebar.contributing"),
path: "/docs/contributing",
},
{
title: i18nT("docs.sidebar.community"),
path: "/docs/community",
},
],
},
{
id: "ui.nav.docs.product",
title: i18nT("docs.sidebar.product"),
path: "",
items: [
{
title: i18nT("docs.sidebar.features"),
path: "/docs/features",
items: [
{
title: i18nT("docs.sidebar.allFeatures"),
path: "/docs/features",
exact: true,
},
{
title: i18nT("docs.sidebar.adminPortal"),
path: "/docs/features/admin-portal",
},
{
title: i18nT("docs.sidebar.appPortal"),
path: "/docs/features/app-portal",
},
{
title: i18nT("docs.sidebar.authentication"),
path: "/docs/features/authentication",
},
{
title: i18nT("docs.sidebar.subscriptions"),
path: "/docs/features/subscriptions",
},
{
title: i18nT("docs.sidebar.entityBuilder"),
path: "/docs/features/entity-builder",
},
{
title: i18nT("docs.sidebar.api"),
path: "/docs/features/api",
},
{
title: i18nT("docs.sidebar.webhooks"),
path: "/docs/features/webhooks",
},
{
title: i18nT("docs.sidebar.auditTrails"),
path: "/docs/features/audit-trails",
},
{
title: i18nT("docs.sidebar.rolesPermissions"),
path: "/docs/features/roles-and-permissions",
},
{
title: i18nT("docs.sidebar.eventsAndWebhooks"),
path: "/docs/features/events-and-webhooks",
},
{
title: i18nT("docs.sidebar.notifications"),
path: "/docs/features/notifications",
},
],
},
{
title: i18nT("docs.sidebar.components"),
path: "/docs/components",
items: [
{
title: i18nT("docs.sidebar.buttons"),
path: "/docs/components/buttons",
},
{
title: i18nT("docs.sidebar.badges"),
path: "/docs/components/badges",
},
{
title: i18nT("docs.sidebar.banners"),
path: "/docs/components/banners",
},
{
title: i18nT("docs.sidebar.breadcrumbs"),
path: "/docs/components/breadcrumbs",
},
{
title: i18nT("docs.sidebar.commandPalette"),
path: "/docs/components/command-palette",
},
{
title: i18nT("docs.sidebar.dropdowns"),
path: "/docs/components/dropdowns",
},
{
title: i18nT("docs.sidebar.emptyStates"),
path: "/docs/components/empty-states",
},
{
title: i18nT("docs.sidebar.forms"),
path: "/docs/components/forms",
},
// {
// title: "Layouts",
// path: "/docs/components/layouts",
//
// },
{
title: i18nT("docs.sidebar.loaders"),
path: "/docs/components/loaders",
},
{
title: i18nT("docs.sidebar.modals"),
path: "/docs/components/modals",
},
{
title: i18nT("docs.sidebar.pdfViewer"),
path: "/docs/components/pdf-viewer",
},
{
title: i18nT("docs.sidebar.tables"),
path: "/docs/components/tables",
},
{
title: i18nT("docs.sidebar.tabs"),
path: "/docs/components/tabs",
},
{
title: i18nT("docs.sidebar.tooltips"),
path: "/docs/components/tooltips",
},
{
title: i18nT("docs.sidebar.uploaders"),
path: "/docs/components/uploaders",
},
{
title: i18nT("docs.sidebar.logoAndIcon"),
path: "/docs/components/logo-and-icon",
},
// {
// title: "Inputs",
// path: "/docs/components/inputs",
//
// items: [
{
title: i18nT("docs.sidebar.inputText"),
path: "/docs/components/inputs/text",
},
{
title: i18nT("docs.sidebar.inputNumber"),
path: "/docs/components/inputs/number",
},
{
title: i18nT("docs.sidebar.inputDate"),
path: "/docs/components/inputs/date",
},
{
title: i18nT("docs.sidebar.inputSelector"),
path: "/docs/components/inputs/selector",
},
{
title: i18nT("docs.sidebar.inputCheckbox"),
path: "/docs/components/inputs/checkbox",
},
{
title: i18nT("docs.sidebar.inputRadioGroup"),
path: "/docs/components/inputs/radio-group",
},
// ],
// },
],
},
],
},
{
id: "ui.nav.docs.learningCenter",
title: i18nT("docs.sidebar.learningCenter"),
path: "/docs/learning-center",
items: [
{ title: i18nT("docs.sidebar.learningCenter"), path: "/docs/learning-center", exact: true },
{
title: i18nT("docs.sidebar.quickStart"),
path: "/docs/learning-center/tutorials/quick-start",
exact: true,
},
{
title: i18nT("docs.sidebar.quickGuides"),
path: "",
items: [
{
title: i18nT("docs.sidebar.productReleases"),
path: "/docs/learning-center/guides/upgrade/product-releases",
},
{
title: i18nT("docs.sidebar.customizeTheme"),
path: "/docs/learning-center/guides/branding/theme",
},
{
title: i18nT("docs.sidebar.customizeLogoIcon"),
path: "/docs/learning-center/guides/branding/logo-and-icon",
},
{
title: i18nT("docs.sidebar.generateFavicon"),
path: "/docs/learning-center/guides/branding/favicon",
},
{
title: i18nT("docs.sidebar.supportLanguageI18n"),
path: "/docs/learning-center/guides/localization/support-a-language",
},
{
title: i18nT("docs.sidebar.createCustomEntity"),
path: "/docs/learning-center/guides/entities/create-a-custom-entity",
},
{
title: i18nT("docs.sidebar.useCustomEntityApi"),
path: "/docs/learning-center/guides/entities/use-the-custom-entity-api",
},
{
title: i18nT("docs.sidebar.sharedEntityRows"),
path: "/docs/learning-center/guides/entities/shared-entity-rows",
},
{
title: i18nT("docs.sidebar.planEntityLimits"),
path: "/docs/learning-center/guides/entities/plan-entity-limits",
},
{
title: i18nT("docs.sidebar.extendExistingModels"),
path: "/docs/learning-center/guides/entities/extend-existing-models",
},
{
title: i18nT("docs.sidebar.singleSignOn"),
path: "/docs/learning-center/guides/sso/",
},
{
title: i18nT("docs.sidebar.vercel"),
path: "/docs/learning-center/guides/hosting/vercel",
},
{
title: i18nT("docs.sidebar.supabase"),
path: "/docs/learning-center/guides/database/supabase",
},
],
},
],
},
{
id: "ui.nav.docs.coreModels",
title: i18nT("docs.sidebar.coreModels"),
path: "",
items: [
{
title: i18nT("docs.sidebar.prismaSchema"),
path: "/docs/core-models",
exact: true,
},
{
title: i18nT("docs.sidebar.account"),
path: "/docs/core-models/account",
items: [
// {
// title: "Diagram",
// path: "/docs/core-models/account/diagram",
//
// },
{
title: i18nT("docs.sidebar.user"),
path: "/docs/core-models/account/user",
},
{
title: i18nT("docs.sidebar.tenant"),
path: "/docs/core-models/account/tenant",
exact: true,
},
{
title: i18nT("docs.sidebar.tenantUser"),
path: "/docs/core-models/account/tenant-user",
},
{
title: i18nT("docs.sidebar.apiKey"),
path: "/docs/core-models/account/api-key",
},
],
},
{
title: i18nT("docs.sidebar.subscription"),
path: "/docs/core-models/subscription",
items: [
{
title: i18nT("docs.sidebar.product"),
path: "/docs/core-models/subscription/product",
},
{
title: i18nT("docs.sidebar.price"),
path: "/docs/core-models/subscription/price",
},
{
title: i18nT("docs.sidebar.feature"),
path: "/docs/core-models/subscription/feature",
},
{
title: i18nT("docs.sidebar.tenantSubscription"),
path: "/docs/core-models/subscription/tenant-subscription",
},
],
},
{
title: i18nT("docs.sidebar.customEntity"),
path: "/docs/core-models/custom-entity",
items: [
{
title: i18nT("docs.sidebar.entity"),
path: "/docs/core-models/custom-entity/entity",
},
{
title: i18nT("docs.sidebar.property"),
path: "/docs/core-models/custom-entity/property",
},
{
title: i18nT("docs.sidebar.row"),
path: "/docs/core-models/custom-entity/row",
exact: true,
},
{
title: i18nT("docs.sidebar.rowValue"),
path: "/docs/core-models/custom-entity/row-value",
},
{
title: i18nT("docs.sidebar.webhook"),
path: "/docs/core-models/custom-entity/webhook",
},
],
},
],
},
]);
};
@@ -0,0 +1,10 @@
import { SideBarItem } from "./SidebarItem";
export type SidebarGroupDto = {
id?: string;
uiIdPattern?: string;
uiIdParams?: Record<string, string | number | boolean | null | undefined>;
items: SideBarItem[];
title?: string;
type?: "main" | "secondary" | "quick-link";
};
@@ -0,0 +1,103 @@
import { describe, expect, it, vi } from "vitest";
import { AdminSidebar } from "./AdminSidebar";
import { AppSidebar } from "./AppSidebar";
import { DocsSidebar } from "./DocsSidebar";
import type { SideBarItem } from "./SidebarItem";
import type { EntitySimple } from "~/utils/db/entities/entities.db.server";
import { UI_ID_PATTERNS, UI_NAV_IDS, UI_SURFACE_IDS } from "~/application/ui/uiRegistry";
function flattenSidebarItems(items: SideBarItem[]): SideBarItem[] {
return items.flatMap((item) => [item, ...flattenSidebarItems(item.items ?? [])]);
}
function expectCompleteUniqueIds(items: SideBarItem[]) {
const flattened = flattenSidebarItems(items);
const ids = flattened.map((item) => item.id);
expect(ids).not.toContain(undefined);
expect(ids.every((id) => id?.startsWith("ui."))).toBe(true);
expect(new Set(ids).size).toBe(ids.length);
}
function expectStaticItemsHaveIds(items: SideBarItem[]) {
const staticItems = flattenSidebarItems(items).filter((item) => !item.uiIdPattern);
expect(staticItems.length).toBeGreaterThan(0);
expect(staticItems.every((item) => typeof item.id === "string" && item.id.length > 0)).toBe(true);
}
function expectDynamicItemsHavePatternMetadata(items: SideBarItem[]) {
const dynamicItems = flattenSidebarItems(items).filter((item) => item.uiIdPattern);
expect(dynamicItems.every((item) => item.id && item.uiIdPattern && item.uiIdParams && Object.keys(item.uiIdParams).length > 0)).toBe(true);
}
describe("sidebar UI IDs", () => {
const t = vi.fn().mockImplementation((v: string) => v) as any;
const i18n = { exists: vi.fn().mockReturnValue(false) } as any;
it("defines the primary sidebar surface IDs", () => {
expect(UI_SURFACE_IDS.appSidebar).toBe("ui.surface.app.sidebar");
expect(UI_SURFACE_IDS.adminSidebar).toBe("ui.surface.admin.sidebar");
expect(UI_SURFACE_IDS.docsSidebar).toBe("ui.surface.docs.sidebar");
});
it("assigns unique IDs to admin sidebar items", () => {
const sidebar = AdminSidebar({ t, appConfiguration: null });
const ids = flattenSidebarItems(sidebar).map((item) => item.id);
expectCompleteUniqueIds(sidebar);
expectStaticItemsHaveIds(sidebar);
expect(ids).toContain(UI_NAV_IDS.adminDashboard);
expect(ids).toContain(UI_NAV_IDS.adminSettings);
expect(ids).toContain(UI_NAV_IDS.adminEntities);
});
it("assigns unique IDs to app sidebar static and dynamic items", () => {
const entities = [
{ id: "1", order: 1, name: "contacts", slug: "contacts", title: "Contact", titlePlural: "Contacts", active: true, type: "custom", hasApi: true, showInSidebar: true, icon: "", onEdit: null },
{ id: "2", order: 2, name: "hidden", slug: "hidden", title: "Hidden", titlePlural: "Hidden", active: true, type: "custom", hasApi: true, showInSidebar: false, icon: "", onEdit: null },
] as EntitySimple[];
const sidebar = AppSidebar({
t,
i18n,
tenantId: "acme",
entities,
entityGroups: [
{
slug: "sales",
title: "Sales",
icon: "",
collapsible: true,
section: "Operations",
entities: [{ entity: entities[0] }],
},
] as any,
appConfiguration: null,
});
const ids = flattenSidebarItems(sidebar).map((item) => item.id);
const dynamicEntity = flattenSidebarItems(sidebar).find((item) => item.id === "ui.nav.app.entity.contacts");
expectCompleteUniqueIds(sidebar);
expectStaticItemsHaveIds(sidebar);
expectDynamicItemsHavePatternMetadata(sidebar);
expect(ids).toContain(UI_NAV_IDS.appDashboard);
expect(ids).toContain(UI_NAV_IDS.appSettings);
expect(ids).toContain("ui.nav.app.entity.contacts");
expect(ids).toContain("ui.nav.app.entityGroup.sales");
expect(ids).toContain("ui.nav.app.section.operations");
expect(dynamicEntity?.uiIdPattern).toBe(UI_ID_PATTERNS.appEntity);
expect(dynamicEntity?.uiIdParams).toMatchObject({ entityName: "contacts", entitySlug: "contacts" });
});
it("assigns unique IDs to docs sidebar items", () => {
const sidebar = DocsSidebar();
const ids = flattenSidebarItems(sidebar).map((item) => item.id);
expectCompleteUniqueIds(sidebar);
expectStaticItemsHaveIds(sidebar);
expectDynamicItemsHavePatternMetadata(sidebar);
expect(ids).toContain(UI_NAV_IDS.docsIntroduction);
expect(ids).toContain("ui.nav.docs.componentsButtons");
const removedDocsPrefix = ["ui.nav.docs.page", "Blocks."].join("");
expect(ids.some((id) => id?.startsWith(removedDocsPrefix))).toBe(false);
});
});
@@ -0,0 +1,29 @@
import { TenantUserType } from "../enums/tenants/TenantUserType";
import { ReactNode } from "react";
import { DefaultPermission } from "../dtos/shared/DefaultPermissions";
export interface SideBarItem {
id?: string;
title: string;
path: string;
uiIdPattern?: string;
uiIdParams?: Record<string, string | number | boolean | null | undefined>;
icon?: ReactNode;
description?: string;
open?: boolean;
adminOnly?: boolean;
tenantUserTypes?: TenantUserType[];
permission?: DefaultPermission;
items?: SideBarItem[];
side?: ReactNode;
exact?: boolean;
redirectTo?: string;
isCollapsible?: boolean;
target?: "_blank" | undefined;
disabled?: boolean;
hidden?: boolean;
isSecondary?: boolean;
isQuickLink?: boolean;
isActive?: boolean;
isExpandedByHref?: boolean;
}