docusaurus-roles-plugin 1.0.0-beta.1

package/src/theme/DocSidebar/index.tsx

@@ -0,0 +1,29 @@
+import DocSidebar, { type Props } from "@theme-init/DocSidebar";
+import { getRoleFrontMatter } from "../../options";
+import { isAllowed, useRoles } from "../../runtime";
+import type {
+  PropSidebarItem,
+  PropSidebarItemCategory,
+} from "@docusaurus/plugin-content-docs";
+
+const allowedOnly = (userRoles: string[]) => {
+  return (item: PropSidebarItem) => {
+    const frontMatter = getRoleFrontMatter(item.customProps);
+    const category = item as PropSidebarItemCategory;
+    if (category.items) {
+      category.items = category.items.filter(allowedOnly(userRoles));
+    }
+    const { allowed } = isAllowed(
+      userRoles,
+      frontMatter.required_roles ?? [],
+      frontMatter.required_roles_mode ?? "all",
+    );
+    return allowed;
+  };
+};
+
+export default function RolesDocSidebar({ sidebar, ...props }: Props) {
+  const { roles } = useRoles();
+  const filteredSidebar = sidebar.filter(allowedOnly(roles));
+  return <DocSidebar {...props} sidebar={filteredSidebar} />;
+}

package/src/theme/NavbarItem/index.tsx

@@ -0,0 +1,16 @@
+import NavbarItem, { Props } from "@theme-init/NavbarItem";
+import { useRoles, isAllowed } from "docusaurus-roles-plugin/runtime";
+import { RoleRequirements } from "../../options";
+
+export default function RolesNavbarItem({
+  requiredRoles = [],
+  requiredRolesMode = "all",
+  ...props
+}: Props & Partial<RoleRequirements>) {
+  const { roles } = useRoles();
+
+  const { allowed } = isAllowed(roles, requiredRoles, requiredRolesMode);
+  if (!allowed) return;
+
+  return <NavbarItem {...props} />;
+}

package/src/theme/RoleGate.tsx

@@ -0,0 +1,53 @@
+import React from "react";
+import { Redirect } from "@docusaurus/router";
+import { usePluginData } from "@docusaurus/useGlobalData";
+import {
+  useRoles,
+  isAllowed,
+  type RoleMode,
+} from "docusaurus-roles-plugin/runtime";
+import RootWarning from "./RootWarning";
+import { PluginOptions } from "../options";
+
+type Props = {
+  requiredRoles?: string[];
+  mode?: RoleMode;
+  children: React.ReactNode;
+  forbidden: React.ElementType<{ missingRoles: string[] }>;
+};
+
+export function getPluginConfig() {
+  return usePluginData("docusaurus-roles-plugin") as PluginOptions;
+}
+
+export default function RoleGate({
+  requiredRoles,
+  mode,
+  children,
+  forbidden: Forbidden,
+}: Props) {
+  const pluginConfig = getPluginConfig();
+  const { roles, loading, hasProvider } = useRoles();
+
+  if (loading) {
+    return <>loading...</>;
+  }
+
+  const required = requiredRoles ?? [];
+  if (required.length === 0) return children;
+
+  const effectiveMode: RoleMode = mode ?? "any";
+
+  if (process.env.NODE_ENV !== "production" && !hasProvider) {
+    return <RootWarning />;
+  }
+
+  const { allowed, missing } = isAllowed(roles, required, effectiveMode);
+  if (allowed) return children;
+
+  if (pluginConfig?.unauthorizedBehavior === "redirect") {
+    return <Redirect to={pluginConfig?.redirectTo ?? "/access-denied"} />;
+  }
+
+  return <Forbidden missingRoles={missing} />;
+}

package/src/theme/RootWarning.tsx

@@ -0,0 +1,18 @@
+import React from "react";
+
+export default function RootWarning() {
+  return (
+    <div style={{ padding: 16 }}>
+      <h2>RolesProvider is missing</h2>
+      <p>
+        You installed <code>docusaurus-plugin-roles</code> but did not wrap your
+        site Root with
+        <code> RolesProvider</code>.
+      </p>
+      <p>
+        Swizzle Root and wrap it with <code>RolesProvider</code> from{" "}
+        <code>docusaurus-plugin-roles/runtime</code>.
+      </p>
+    </div>
+  );
+}