docusaurus-roles-plugin 1.0.0-beta.1

package/dist/runtime/index.cjs

@@ -0,0 +1,202 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/runtime/index.ts
+var runtime_exports = {};
+__export(runtime_exports, {
+  BaseForbiddenContent: () => BaseForbiddenContent,
+  RolesContext: () => RolesContext,
+  RolesProvider: () => RolesProvider,
+  isAllowed: () => isAllowed,
+  useRoles: () => useRoles
+});
+module.exports = __toCommonJS(runtime_exports);
+
+// src/runtime/context.tsx
+var import_react = __toESM(require("react"), 1);
+var RolesContext = import_react.default.createContext({
+  roles: [],
+  loading: false,
+  hasProvider: false
+});
+
+// src/runtime/RolesProvider.tsx
+var import_react2 = require("react");
+var import_jsx_runtime = require("react/jsx-runtime");
+var DefaultRolesLoading = () => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
+    "div",
+    {
+      style: {
+        display: "flex",
+        flexGrow: 1,
+        flexDirection: "column",
+        justifyContent: "center",
+        alignItems: "center"
+      },
+      children: "Checking Permissions..."
+    }
+  );
+};
+var DefaultRolesError = ({ error }) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
+    "div",
+    {
+      style: {
+        display: "flex",
+        flexGrow: 1,
+        flexDirection: "column",
+        justifyContent: "center",
+        alignItems: "center",
+        color: "#c1121f"
+      },
+      children: error.message
+    }
+  );
+};
+function RolesProvider({
+  roles: getRoles,
+  slots = {},
+  children
+}) {
+  const LoadingComponent = slots.loading ?? DefaultRolesLoading;
+  const ErrorComponent = slots.error ?? DefaultRolesError;
+  const [state, setState] = (0, import_react2.useState)({
+    roles: [],
+    loading: true,
+    hasProvider: true
+  });
+  (0, import_react2.useEffect)(() => {
+    const fetchRoles = async () => {
+      try {
+        setState((s) => ({ ...s, loading: true }));
+        const roles = await getRoles();
+        if (!roles) {
+          console.warn(
+            "No roles were returned an empty array should be returned if user has no roles."
+          );
+        }
+        setState((s) => ({
+          ...s,
+          loading: false,
+          roles
+        }));
+      } catch (e) {
+        setState((s) => ({
+          ...s,
+          loading: false,
+          roles: [],
+          error: e instanceof Error ? e : new Error(String(e))
+        }));
+      }
+    };
+    fetchRoles();
+  }, [getRoles]);
+  if (state.loading) {
+    return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(LoadingComponent, {});
+  }
+  if (state.error) {
+    return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(ErrorComponent, { error: state.error });
+  }
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(RolesContext.Provider, { value: state, children });
+}
+
+// src/runtime/useRoles.ts
+var import_react3 = require("react");
+function useRoles() {
+  return (0, import_react3.useContext)(RolesContext);
+}
+
+// src/runtime/roleUtils.ts
+function isAllowed(userRoles, required, mode) {
+  if (!required || required.length === 0) {
+    return { allowed: true, missing: [] };
+  }
+  const userRoleSet = new Set(userRoles);
+  if (mode === "all") {
+    const missing = required.filter((r) => !userRoleSet.has(r));
+    return {
+      allowed: missing.length === 0,
+      missing
+    };
+  }
+  const hasAny = required.some((r) => userRoleSet.has(r));
+  return {
+    allowed: hasAny,
+    missing: hasAny ? [] : required.slice()
+    // nothing matched → all are effectively missing
+  };
+}
+
+// src/runtime/BaseForbiddenContent.tsx
+var import_Translate = __toESM(require("@docusaurus/Translate"), 1);
+var import_Heading = __toESM(require("@theme/Heading"), 1);
+var import_jsx_runtime2 = require("react/jsx-runtime");
+function BaseForbiddenContent({
+  prefixTranslateId,
+  title = "Forbidden",
+  shortDescription = "You don't have permission to access this page.",
+  description = "If you believe this is a mistake, contact the site owner or sign in with an account that has access."
+}) {
+  return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("div", { className: "row", children: /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)("div", { className: "col", children: [
+    /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_Heading.default, { as: "h1", className: "hero__title", children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
+      import_Translate.default,
+      {
+        id: `${prefixTranslateId}.title`,
+        description: "The title of the 403 page",
+        children: title
+      }
+    ) }),
+    /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("p", { children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
+      import_Translate.default,
+      {
+        id: `${prefixTranslateId}.p1`,
+        description: "The first paragraph of the 403 page",
+        children: shortDescription
+      }
+    ) }),
+    /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("p", { children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
+      import_Translate.default,
+      {
+        id: `${prefixTranslateId}.p2`,
+        description: "The 2nd paragraph of the 403 page",
+        children: description
+      }
+    ) })
+  ] }) });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BaseForbiddenContent,
+  RolesContext,
+  RolesProvider,
+  isAllowed,
+  useRoles
+});
+//# sourceMappingURL=index.cjs.map

package/dist/runtime/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/index.ts","../../src/runtime/context.tsx","../../src/runtime/RolesProvider.tsx","../../src/runtime/useRoles.ts","../../src/runtime/roleUtils.ts","../../src/runtime/BaseForbiddenContent.tsx"],"sourcesContent":["export { RolesContext } from \"./context\";\nexport type { RolesState } from \"./context\";\n\nexport { RolesProvider } from \"./RolesProvider\";\nexport type { RolesProviderProps } from \"./RolesProvider\";\n\nexport { useRoles } from \"./useRoles\";\nexport { isAllowed } from \"./roleUtils\";\nexport type { RoleMode } from \"./roleUtils\";\nexport * from \"./BaseForbiddenContent\";\n","import React from \"react\";\n\nexport type RolesState = {\n  roles: string[];\n  loading: boolean;\n  error?: Error;\n  /** true if RolesProvider is mounted */\n  hasProvider: boolean;\n};\n\nexport const RolesContext = React.createContext<RolesState>({\n  roles: [],\n  loading: false,\n  hasProvider: false,\n});\n","import React, { useEffect, useState } from \"react\";\nimport type { PropsWithChildren } from \"react\";\nimport { RolesContext, type RolesState } from \"./context\";\n\nexport type ErrorSlotProps = {\n  error: Error;\n};\n\nexport type RolesProviderProps = PropsWithChildren<{\n  roles: () => Promise<string[]> | string[];\n  slots?: {\n    loading?: React.ElementType;\n    error?: React.ElementType<ErrorSlotProps>;\n  };\n}>;\n\nexport const DefaultRolesLoading = () => {\n  return (\n    <div\n      style={{\n        display: \"flex\",\n        flexGrow: 1,\n        flexDirection: \"column\",\n        justifyContent: \"center\",\n        alignItems: \"center\",\n      }}\n    >\n      Checking Permissions...\n    </div>\n  );\n};\n\nexport const DefaultRolesError = ({ error }: ErrorSlotProps) => {\n  return (\n    <div\n      style={{\n        display: \"flex\",\n        flexGrow: 1,\n        flexDirection: \"column\",\n        justifyContent: \"center\",\n        alignItems: \"center\",\n        color: \"#c1121f\",\n      }}\n    >\n      {error.message}\n    </div>\n  );\n};\n\nexport function RolesProvider({\n  roles: getRoles,\n  slots = {},\n  children,\n}: RolesProviderProps) {\n  const LoadingComponent = slots.loading ?? DefaultRolesLoading;\n  const ErrorComponent = slots.error ?? DefaultRolesError;\n\n  const [state, setState] = useState<RolesState>({\n    roles: [],\n    loading: true,\n    hasProvider: true,\n  });\n\n  useEffect(() => {\n    const fetchRoles = async () => {\n      try {\n        setState((s) => ({ ...s, loading: true }));\n        const roles = await getRoles();\n        if (!roles) {\n          console.warn(\n            \"No roles were returned an empty array should be returned if user has no roles.\",\n          );\n        }\n        setState((s) => ({\n          ...s,\n          loading: false,\n          roles: roles,\n        }));\n      } catch (e) {\n        setState((s) => ({\n          ...s,\n          loading: false,\n          roles: [],\n          error: e instanceof Error ? e : new Error(String(e)),\n        }));\n      }\n    };\n\n    fetchRoles();\n  }, [getRoles]);\n\n  if (state.loading) {\n    return <LoadingComponent />;\n  }\n\n  if (state.error) {\n    return <ErrorComponent error={state.error} />;\n  }\n\n  return (\n    <RolesContext.Provider value={state}>{children}</RolesContext.Provider>\n  );\n}\n","import { useContext } from \"react\";\nimport { RolesContext } from \"./context\";\n\nexport function useRoles() {\n  return useContext(RolesContext);\n}\n","export type RoleMode = \"any\" | \"all\";\n\nexport type RoleCheckResult = {\n  allowed: boolean;\n  missing: string[];\n};\n\nexport function isAllowed(\n  userRoles: string[],\n  required: string[],\n  mode: RoleMode,\n): RoleCheckResult {\n  // No requirements → always allowed\n  if (!required || required.length === 0) {\n    return { allowed: true, missing: [] };\n  }\n\n  const userRoleSet = new Set(userRoles);\n\n  if (mode === \"all\") {\n    const missing = required.filter((r) => !userRoleSet.has(r));\n    return {\n      allowed: missing.length === 0,\n      missing,\n    };\n  }\n\n  // mode === \"any\"\n  const hasAny = required.some((r) => userRoleSet.has(r));\n  return {\n    allowed: hasAny,\n    missing: hasAny ? [] : required.slice(), // nothing matched → all are effectively missing\n  };\n}\n","import { JSX } from \"react\";\nimport type { Props as NotFoundProps } from \"@theme/NotFound/Content\";\nimport Translate from \"@docusaurus/Translate\";\nimport Heading from \"@theme/Heading\";\n\nexport type BaseForbiddenContentProps = {\n  prefixTranslateId: string;\n  title?: string;\n  shortDescription?: string;\n  description?: string;\n} & NotFoundProps;\n\nexport function BaseForbiddenContent({\n  prefixTranslateId,\n  title = \"Forbidden\",\n  shortDescription = \"You don't have permission to access this page.\",\n  description = \"If you believe this is a mistake, contact the site owner or sign in with an account that has access.\",\n}: BaseForbiddenContentProps): JSX.Element {\n  return (\n    <div className=\"row\">\n      <div className=\"col\">\n        <Heading as=\"h1\" className=\"hero__title\">\n          <Translate\n            id={`${prefixTranslateId}.title`}\n            description=\"The title of the 403 page\"\n          >\n            {title}\n          </Translate>\n        </Heading>\n        <p>\n          <Translate\n            id={`${prefixTranslateId}.p1`}\n            description=\"The first paragraph of the 403 page\"\n          >\n            {shortDescription}\n          </Translate>\n        </p>\n        <p>\n          <Translate\n            id={`${prefixTranslateId}.p2`}\n            description=\"The 2nd paragraph of the 403 page\"\n          >\n            {description}\n          </Translate>\n        </p>\n      </div>\n    </div>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAkB;AAUX,IAAM,eAAe,aAAAA,QAAM,cAA0B;AAAA,EAC1D,OAAO,CAAC;AAAA,EACR,SAAS;AAAA,EACT,aAAa;AACf,CAAC;;;ACdD,IAAAC,gBAA2C;AAkBvC;AAFG,IAAM,sBAAsB,MAAM;AACvC,SACE;AAAA,IAAC;AAAA;AAAA,MACC,OAAO;AAAA,QACL,SAAS;AAAA,QACT,UAAU;AAAA,QACV,eAAe;AAAA,QACf,gBAAgB;AAAA,QAChB,YAAY;AAAA,MACd;AAAA,MACD;AAAA;AAAA,EAED;AAEJ;AAEO,IAAM,oBAAoB,CAAC,EAAE,MAAM,MAAsB;AAC9D,SACE;AAAA,IAAC;AAAA;AAAA,MACC,OAAO;AAAA,QACL,SAAS;AAAA,QACT,UAAU;AAAA,QACV,eAAe;AAAA,QACf,gBAAgB;AAAA,QAChB,YAAY;AAAA,QACZ,OAAO;AAAA,MACT;AAAA,MAEC,gBAAM;AAAA;AAAA,EACT;AAEJ;AAEO,SAAS,cAAc;AAAA,EAC5B,OAAO;AAAA,EACP,QAAQ,CAAC;AAAA,EACT;AACF,GAAuB;AACrB,QAAM,mBAAmB,MAAM,WAAW;AAC1C,QAAM,iBAAiB,MAAM,SAAS;AAEtC,QAAM,CAAC,OAAO,QAAQ,QAAI,wBAAqB;AAAA,IAC7C,OAAO,CAAC;AAAA,IACR,SAAS;AAAA,IACT,aAAa;AAAA,EACf,CAAC;AAED,+BAAU,MAAM;AACd,UAAM,aAAa,YAAY;AAC7B,UAAI;AACF,iBAAS,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,KAAK,EAAE;AACzC,cAAM,QAAQ,MAAM,SAAS;AAC7B,YAAI,CAAC,OAAO;AACV,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,iBAAS,CAAC,OAAO;AAAA,UACf,GAAG;AAAA,UACH,SAAS;AAAA,UACT;AAAA,QACF,EAAE;AAAA,MACJ,SAAS,GAAG;AACV,iBAAS,CAAC,OAAO;AAAA,UACf,GAAG;AAAA,UACH,SAAS;AAAA,UACT,OAAO,CAAC;AAAA,UACR,OAAO,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAAA,QACrD,EAAE;AAAA,MACJ;AAAA,IACF;AAEA,eAAW;AAAA,EACb,GAAG,CAAC,QAAQ,CAAC;AAEb,MAAI,MAAM,SAAS;AACjB,WAAO,4CAAC,oBAAiB;AAAA,EAC3B;AAEA,MAAI,MAAM,OAAO;AACf,WAAO,4CAAC,kBAAe,OAAO,MAAM,OAAO;AAAA,EAC7C;AAEA,SACE,4CAAC,aAAa,UAAb,EAAsB,OAAO,OAAQ,UAAS;AAEnD;;;ACtGA,IAAAC,gBAA2B;AAGpB,SAAS,WAAW;AACzB,aAAO,0BAAW,YAAY;AAChC;;;ACEO,SAAS,UACd,WACA,UACA,MACiB;AAEjB,MAAI,CAAC,YAAY,SAAS,WAAW,GAAG;AACtC,WAAO,EAAE,SAAS,MAAM,SAAS,CAAC,EAAE;AAAA,EACtC;AAEA,QAAM,cAAc,IAAI,IAAI,SAAS;AAErC,MAAI,SAAS,OAAO;AAClB,UAAM,UAAU,SAAS,OAAO,CAAC,MAAM,CAAC,YAAY,IAAI,CAAC,CAAC;AAC1D,WAAO;AAAA,MACL,SAAS,QAAQ,WAAW;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAGA,QAAM,SAAS,SAAS,KAAK,CAAC,MAAM,YAAY,IAAI,CAAC,CAAC;AACtD,SAAO;AAAA,IACL,SAAS;AAAA,IACT,SAAS,SAAS,CAAC,IAAI,SAAS,MAAM;AAAA;AAAA,EACxC;AACF;;;AC/BA,uBAAsB;AACtB,qBAAoB;AAiBd,IAAAC,sBAAA;AARC,SAAS,qBAAqB;AAAA,EACnC;AAAA,EACA,QAAQ;AAAA,EACR,mBAAmB;AAAA,EACnB,cAAc;AAChB,GAA2C;AACzC,SACE,6CAAC,SAAI,WAAU,OACb,wDAAC,SAAI,WAAU,OACb;AAAA,iDAAC,eAAAC,SAAA,EAAQ,IAAG,MAAK,WAAU,eACzB;AAAA,MAAC,iBAAAC;AAAA,MAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,IACA,6CAAC,OACC;AAAA,MAAC,iBAAAA;AAAA,MAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,IACA,6CAAC,OACC;AAAA,MAAC,iBAAAA;AAAA,MAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,KACF,GACF;AAEJ;","names":["React","import_react","import_react","import_jsx_runtime","Heading","Translate"]}

package/dist/runtime/index.d.cts

@@ -0,0 +1,43 @@
+import React, { PropsWithChildren, JSX } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Props } from '@theme/NotFound/Content';
+
+type RolesState = {
+    roles: string[];
+    loading: boolean;
+    error?: Error;
+    /** true if RolesProvider is mounted */
+    hasProvider: boolean;
+};
+declare const RolesContext: React.Context<RolesState>;
+
+type ErrorSlotProps = {
+    error: Error;
+};
+type RolesProviderProps = PropsWithChildren<{
+    roles: () => Promise<string[]> | string[];
+    slots?: {
+        loading?: React.ElementType;
+        error?: React.ElementType<ErrorSlotProps>;
+    };
+}>;
+declare function RolesProvider({ roles: getRoles, slots, children, }: RolesProviderProps): react_jsx_runtime.JSX.Element;
+
+declare function useRoles(): RolesState;
+
+type RoleMode = "any" | "all";
+type RoleCheckResult = {
+    allowed: boolean;
+    missing: string[];
+};
+declare function isAllowed(userRoles: string[], required: string[], mode: RoleMode): RoleCheckResult;
+
+type BaseForbiddenContentProps = {
+    prefixTranslateId: string;
+    title?: string;
+    shortDescription?: string;
+    description?: string;
+} & Props;
+declare function BaseForbiddenContent({ prefixTranslateId, title, shortDescription, description, }: BaseForbiddenContentProps): JSX.Element;
+
+export { BaseForbiddenContent, type BaseForbiddenContentProps, type RoleMode, RolesContext, RolesProvider, type RolesProviderProps, type RolesState, isAllowed, useRoles };

package/dist/runtime/index.d.ts

@@ -0,0 +1,43 @@
+import React, { PropsWithChildren, JSX } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Props } from '@theme/NotFound/Content';
+
+type RolesState = {
+    roles: string[];
+    loading: boolean;
+    error?: Error;
+    /** true if RolesProvider is mounted */
+    hasProvider: boolean;
+};
+declare const RolesContext: React.Context<RolesState>;
+
+type ErrorSlotProps = {
+    error: Error;
+};
+type RolesProviderProps = PropsWithChildren<{
+    roles: () => Promise<string[]> | string[];
+    slots?: {
+        loading?: React.ElementType;
+        error?: React.ElementType<ErrorSlotProps>;
+    };
+}>;
+declare function RolesProvider({ roles: getRoles, slots, children, }: RolesProviderProps): react_jsx_runtime.JSX.Element;
+
+declare function useRoles(): RolesState;
+
+type RoleMode = "any" | "all";
+type RoleCheckResult = {
+    allowed: boolean;
+    missing: string[];
+};
+declare function isAllowed(userRoles: string[], required: string[], mode: RoleMode): RoleCheckResult;
+
+type BaseForbiddenContentProps = {
+    prefixTranslateId: string;
+    title?: string;
+    shortDescription?: string;
+    description?: string;
+} & Props;
+declare function BaseForbiddenContent({ prefixTranslateId, title, shortDescription, description, }: BaseForbiddenContentProps): JSX.Element;
+
+export { BaseForbiddenContent, type BaseForbiddenContentProps, type RoleMode, RolesContext, RolesProvider, type RolesProviderProps, type RolesState, isAllowed, useRoles };

package/dist/runtime/index.js

@@ -0,0 +1,161 @@
+// src/runtime/context.tsx
+import React from "react";
+var RolesContext = React.createContext({
+  roles: [],
+  loading: false,
+  hasProvider: false
+});
+
+// src/runtime/RolesProvider.tsx
+import { useEffect, useState } from "react";
+import { jsx } from "react/jsx-runtime";
+var DefaultRolesLoading = () => {
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      style: {
+        display: "flex",
+        flexGrow: 1,
+        flexDirection: "column",
+        justifyContent: "center",
+        alignItems: "center"
+      },
+      children: "Checking Permissions..."
+    }
+  );
+};
+var DefaultRolesError = ({ error }) => {
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      style: {
+        display: "flex",
+        flexGrow: 1,
+        flexDirection: "column",
+        justifyContent: "center",
+        alignItems: "center",
+        color: "#c1121f"
+      },
+      children: error.message
+    }
+  );
+};
+function RolesProvider({
+  roles: getRoles,
+  slots = {},
+  children
+}) {
+  const LoadingComponent = slots.loading ?? DefaultRolesLoading;
+  const ErrorComponent = slots.error ?? DefaultRolesError;
+  const [state, setState] = useState({
+    roles: [],
+    loading: true,
+    hasProvider: true
+  });
+  useEffect(() => {
+    const fetchRoles = async () => {
+      try {
+        setState((s) => ({ ...s, loading: true }));
+        const roles = await getRoles();
+        if (!roles) {
+          console.warn(
+            "No roles were returned an empty array should be returned if user has no roles."
+          );
+        }
+        setState((s) => ({
+          ...s,
+          loading: false,
+          roles
+        }));
+      } catch (e) {
+        setState((s) => ({
+          ...s,
+          loading: false,
+          roles: [],
+          error: e instanceof Error ? e : new Error(String(e))
+        }));
+      }
+    };
+    fetchRoles();
+  }, [getRoles]);
+  if (state.loading) {
+    return /* @__PURE__ */ jsx(LoadingComponent, {});
+  }
+  if (state.error) {
+    return /* @__PURE__ */ jsx(ErrorComponent, { error: state.error });
+  }
+  return /* @__PURE__ */ jsx(RolesContext.Provider, { value: state, children });
+}
+
+// src/runtime/useRoles.ts
+import { useContext } from "react";
+function useRoles() {
+  return useContext(RolesContext);
+}
+
+// src/runtime/roleUtils.ts
+function isAllowed(userRoles, required, mode) {
+  if (!required || required.length === 0) {
+    return { allowed: true, missing: [] };
+  }
+  const userRoleSet = new Set(userRoles);
+  if (mode === "all") {
+    const missing = required.filter((r) => !userRoleSet.has(r));
+    return {
+      allowed: missing.length === 0,
+      missing
+    };
+  }
+  const hasAny = required.some((r) => userRoleSet.has(r));
+  return {
+    allowed: hasAny,
+    missing: hasAny ? [] : required.slice()
+    // nothing matched → all are effectively missing
+  };
+}
+
+// src/runtime/BaseForbiddenContent.tsx
+import Translate from "@docusaurus/Translate";
+import Heading from "@theme/Heading";
+import { jsx as jsx2, jsxs } from "react/jsx-runtime";
+function BaseForbiddenContent({
+  prefixTranslateId,
+  title = "Forbidden",
+  shortDescription = "You don't have permission to access this page.",
+  description = "If you believe this is a mistake, contact the site owner or sign in with an account that has access."
+}) {
+  return /* @__PURE__ */ jsx2("div", { className: "row", children: /* @__PURE__ */ jsxs("div", { className: "col", children: [
+    /* @__PURE__ */ jsx2(Heading, { as: "h1", className: "hero__title", children: /* @__PURE__ */ jsx2(
+      Translate,
+      {
+        id: `${prefixTranslateId}.title`,
+        description: "The title of the 403 page",
+        children: title
+      }
+    ) }),
+    /* @__PURE__ */ jsx2("p", { children: /* @__PURE__ */ jsx2(
+      Translate,
+      {
+        id: `${prefixTranslateId}.p1`,
+        description: "The first paragraph of the 403 page",
+        children: shortDescription
+      }
+    ) }),
+    /* @__PURE__ */ jsx2("p", { children: /* @__PURE__ */ jsx2(
+      Translate,
+      {
+        id: `${prefixTranslateId}.p2`,
+        description: "The 2nd paragraph of the 403 page",
+        children: description
+      }
+    ) })
+  ] }) });
+}
+export {
+  BaseForbiddenContent,
+  RolesContext,
+  RolesProvider,
+  isAllowed,
+  useRoles
+};
+//# sourceMappingURL=index.js.map

package/dist/runtime/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/context.tsx","../../src/runtime/RolesProvider.tsx","../../src/runtime/useRoles.ts","../../src/runtime/roleUtils.ts","../../src/runtime/BaseForbiddenContent.tsx"],"sourcesContent":["import React from \"react\";\n\nexport type RolesState = {\n  roles: string[];\n  loading: boolean;\n  error?: Error;\n  /** true if RolesProvider is mounted */\n  hasProvider: boolean;\n};\n\nexport const RolesContext = React.createContext<RolesState>({\n  roles: [],\n  loading: false,\n  hasProvider: false,\n});\n","import React, { useEffect, useState } from \"react\";\nimport type { PropsWithChildren } from \"react\";\nimport { RolesContext, type RolesState } from \"./context\";\n\nexport type ErrorSlotProps = {\n  error: Error;\n};\n\nexport type RolesProviderProps = PropsWithChildren<{\n  roles: () => Promise<string[]> | string[];\n  slots?: {\n    loading?: React.ElementType;\n    error?: React.ElementType<ErrorSlotProps>;\n  };\n}>;\n\nexport const DefaultRolesLoading = () => {\n  return (\n    <div\n      style={{\n        display: \"flex\",\n        flexGrow: 1,\n        flexDirection: \"column\",\n        justifyContent: \"center\",\n        alignItems: \"center\",\n      }}\n    >\n      Checking Permissions...\n    </div>\n  );\n};\n\nexport const DefaultRolesError = ({ error }: ErrorSlotProps) => {\n  return (\n    <div\n      style={{\n        display: \"flex\",\n        flexGrow: 1,\n        flexDirection: \"column\",\n        justifyContent: \"center\",\n        alignItems: \"center\",\n        color: \"#c1121f\",\n      }}\n    >\n      {error.message}\n    </div>\n  );\n};\n\nexport function RolesProvider({\n  roles: getRoles,\n  slots = {},\n  children,\n}: RolesProviderProps) {\n  const LoadingComponent = slots.loading ?? DefaultRolesLoading;\n  const ErrorComponent = slots.error ?? DefaultRolesError;\n\n  const [state, setState] = useState<RolesState>({\n    roles: [],\n    loading: true,\n    hasProvider: true,\n  });\n\n  useEffect(() => {\n    const fetchRoles = async () => {\n      try {\n        setState((s) => ({ ...s, loading: true }));\n        const roles = await getRoles();\n        if (!roles) {\n          console.warn(\n            \"No roles were returned an empty array should be returned if user has no roles.\",\n          );\n        }\n        setState((s) => ({\n          ...s,\n          loading: false,\n          roles: roles,\n        }));\n      } catch (e) {\n        setState((s) => ({\n          ...s,\n          loading: false,\n          roles: [],\n          error: e instanceof Error ? e : new Error(String(e)),\n        }));\n      }\n    };\n\n    fetchRoles();\n  }, [getRoles]);\n\n  if (state.loading) {\n    return <LoadingComponent />;\n  }\n\n  if (state.error) {\n    return <ErrorComponent error={state.error} />;\n  }\n\n  return (\n    <RolesContext.Provider value={state}>{children}</RolesContext.Provider>\n  );\n}\n","import { useContext } from \"react\";\nimport { RolesContext } from \"./context\";\n\nexport function useRoles() {\n  return useContext(RolesContext);\n}\n","export type RoleMode = \"any\" | \"all\";\n\nexport type RoleCheckResult = {\n  allowed: boolean;\n  missing: string[];\n};\n\nexport function isAllowed(\n  userRoles: string[],\n  required: string[],\n  mode: RoleMode,\n): RoleCheckResult {\n  // No requirements → always allowed\n  if (!required || required.length === 0) {\n    return { allowed: true, missing: [] };\n  }\n\n  const userRoleSet = new Set(userRoles);\n\n  if (mode === \"all\") {\n    const missing = required.filter((r) => !userRoleSet.has(r));\n    return {\n      allowed: missing.length === 0,\n      missing,\n    };\n  }\n\n  // mode === \"any\"\n  const hasAny = required.some((r) => userRoleSet.has(r));\n  return {\n    allowed: hasAny,\n    missing: hasAny ? [] : required.slice(), // nothing matched → all are effectively missing\n  };\n}\n","import { JSX } from \"react\";\nimport type { Props as NotFoundProps } from \"@theme/NotFound/Content\";\nimport Translate from \"@docusaurus/Translate\";\nimport Heading from \"@theme/Heading\";\n\nexport type BaseForbiddenContentProps = {\n  prefixTranslateId: string;\n  title?: string;\n  shortDescription?: string;\n  description?: string;\n} & NotFoundProps;\n\nexport function BaseForbiddenContent({\n  prefixTranslateId,\n  title = \"Forbidden\",\n  shortDescription = \"You don't have permission to access this page.\",\n  description = \"If you believe this is a mistake, contact the site owner or sign in with an account that has access.\",\n}: BaseForbiddenContentProps): JSX.Element {\n  return (\n    <div className=\"row\">\n      <div className=\"col\">\n        <Heading as=\"h1\" className=\"hero__title\">\n          <Translate\n            id={`${prefixTranslateId}.title`}\n            description=\"The title of the 403 page\"\n          >\n            {title}\n          </Translate>\n        </Heading>\n        <p>\n          <Translate\n            id={`${prefixTranslateId}.p1`}\n            description=\"The first paragraph of the 403 page\"\n          >\n            {shortDescription}\n          </Translate>\n        </p>\n        <p>\n          <Translate\n            id={`${prefixTranslateId}.p2`}\n            description=\"The 2nd paragraph of the 403 page\"\n          >\n            {description}\n          </Translate>\n        </p>\n      </div>\n    </div>\n  );\n}\n"],"mappings":";AAAA,OAAO,WAAW;AAUX,IAAM,eAAe,MAAM,cAA0B;AAAA,EAC1D,OAAO,CAAC;AAAA,EACR,SAAS;AAAA,EACT,aAAa;AACf,CAAC;;;ACdD,SAAgB,WAAW,gBAAgB;AAkBvC;AAFG,IAAM,sBAAsB,MAAM;AACvC,SACE;AAAA,IAAC;AAAA;AAAA,MACC,OAAO;AAAA,QACL,SAAS;AAAA,QACT,UAAU;AAAA,QACV,eAAe;AAAA,QACf,gBAAgB;AAAA,QAChB,YAAY;AAAA,MACd;AAAA,MACD;AAAA;AAAA,EAED;AAEJ;AAEO,IAAM,oBAAoB,CAAC,EAAE,MAAM,MAAsB;AAC9D,SACE;AAAA,IAAC;AAAA;AAAA,MACC,OAAO;AAAA,QACL,SAAS;AAAA,QACT,UAAU;AAAA,QACV,eAAe;AAAA,QACf,gBAAgB;AAAA,QAChB,YAAY;AAAA,QACZ,OAAO;AAAA,MACT;AAAA,MAEC,gBAAM;AAAA;AAAA,EACT;AAEJ;AAEO,SAAS,cAAc;AAAA,EAC5B,OAAO;AAAA,EACP,QAAQ,CAAC;AAAA,EACT;AACF,GAAuB;AACrB,QAAM,mBAAmB,MAAM,WAAW;AAC1C,QAAM,iBAAiB,MAAM,SAAS;AAEtC,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAqB;AAAA,IAC7C,OAAO,CAAC;AAAA,IACR,SAAS;AAAA,IACT,aAAa;AAAA,EACf,CAAC;AAED,YAAU,MAAM;AACd,UAAM,aAAa,YAAY;AAC7B,UAAI;AACF,iBAAS,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,KAAK,EAAE;AACzC,cAAM,QAAQ,MAAM,SAAS;AAC7B,YAAI,CAAC,OAAO;AACV,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,iBAAS,CAAC,OAAO;AAAA,UACf,GAAG;AAAA,UACH,SAAS;AAAA,UACT;AAAA,QACF,EAAE;AAAA,MACJ,SAAS,GAAG;AACV,iBAAS,CAAC,OAAO;AAAA,UACf,GAAG;AAAA,UACH,SAAS;AAAA,UACT,OAAO,CAAC;AAAA,UACR,OAAO,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAAA,QACrD,EAAE;AAAA,MACJ;AAAA,IACF;AAEA,eAAW;AAAA,EACb,GAAG,CAAC,QAAQ,CAAC;AAEb,MAAI,MAAM,SAAS;AACjB,WAAO,oBAAC,oBAAiB;AAAA,EAC3B;AAEA,MAAI,MAAM,OAAO;AACf,WAAO,oBAAC,kBAAe,OAAO,MAAM,OAAO;AAAA,EAC7C;AAEA,SACE,oBAAC,aAAa,UAAb,EAAsB,OAAO,OAAQ,UAAS;AAEnD;;;ACtGA,SAAS,kBAAkB;AAGpB,SAAS,WAAW;AACzB,SAAO,WAAW,YAAY;AAChC;;;ACEO,SAAS,UACd,WACA,UACA,MACiB;AAEjB,MAAI,CAAC,YAAY,SAAS,WAAW,GAAG;AACtC,WAAO,EAAE,SAAS,MAAM,SAAS,CAAC,EAAE;AAAA,EACtC;AAEA,QAAM,cAAc,IAAI,IAAI,SAAS;AAErC,MAAI,SAAS,OAAO;AAClB,UAAM,UAAU,SAAS,OAAO,CAAC,MAAM,CAAC,YAAY,IAAI,CAAC,CAAC;AAC1D,WAAO;AAAA,MACL,SAAS,QAAQ,WAAW;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAGA,QAAM,SAAS,SAAS,KAAK,CAAC,MAAM,YAAY,IAAI,CAAC,CAAC;AACtD,SAAO;AAAA,IACL,SAAS;AAAA,IACT,SAAS,SAAS,CAAC,IAAI,SAAS,MAAM;AAAA;AAAA,EACxC;AACF;;;AC/BA,OAAO,eAAe;AACtB,OAAO,aAAa;AAiBd,SAEI,OAAAA,MAFJ;AARC,SAAS,qBAAqB;AAAA,EACnC;AAAA,EACA,QAAQ;AAAA,EACR,mBAAmB;AAAA,EACnB,cAAc;AAChB,GAA2C;AACzC,SACE,gBAAAA,KAAC,SAAI,WAAU,OACb,+BAAC,SAAI,WAAU,OACb;AAAA,oBAAAA,KAAC,WAAQ,IAAG,MAAK,WAAU,eACzB,0BAAAA;AAAA,MAAC;AAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,IACA,gBAAAA,KAAC,OACC,0BAAAA;AAAA,MAAC;AAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,IACA,gBAAAA,KAAC,OACC,0BAAAA;AAAA,MAAC;AAAA;AAAA,QACC,IAAI,GAAG,iBAAiB;AAAA,QACxB,aAAY;AAAA,QAEX;AAAA;AAAA,IACH,GACF;AAAA,KACF,GACF;AAEJ;","names":["jsx"]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "docusaurus-roles-plugin",
+  "version": "1.0.0-beta.1",
+  "description": "Role-based gating for Docusaurus docs/blog via React context + front matter",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "require": "./dist/runtime/index.cjs",
+      "import": "./dist/runtime/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "src/theme"
+  ],
+  "dependencies": {
+    "@docusaurus/logger": "^3.9.0"
+  },
+  "peerDependencies": {
+    "@docusaurus/core": "^3.9.0",
+    "@docusaurus/theme-common": "^3.9.0",
+    "@docusaurus/theme-translations": "^3.9.0",
+    "@docusaurus/utils-validation": "^3.9.0",
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.0",
+    "@docusaurus/types": "^3.9.0",
+    "@docusaurus/theme-classic": "^3.9.0",
+    "@docusaurus/module-type-aliases": "^3.9.0",
+    "@docusaurus/plugin-content-blog": "^3.9.0",
+    "@docusaurus/plugin-content-docs": "^3.9.0",
+    "tsup": "^8.5.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}

package/src/theme/BlogListPage/index.tsx

@@ -0,0 +1,20 @@
+import BlogListPage from "@theme-init/BlogListPage";
+import { useRoles, isAllowed } from "docusaurus-roles-plugin/runtime";
+import type { Props } from "@theme/BlogListPage";
+import { getRoleFrontMatter } from "../../options";
+
+export default function BlogListPageWrapper({ items, ...rest }: Props) {
+  const { roles, loading } = useRoles();
+
+  const filteredItems = items.filter((i) => {
+    const frontMatter = getRoleFrontMatter(i.content.frontMatter);
+    const { allowed } = isAllowed(
+      roles,
+      frontMatter.required_roles ?? [],
+      frontMatter.required_roles_mode ?? "all",
+    );
+    return allowed;
+  });
+
+  return <BlogListPage {...rest} items={filteredItems} />;
+}

package/src/theme/BlogPostItem/Forbidden.tsx

@@ -0,0 +1,17 @@
+import { type ReactNode } from "react";
+import { BaseForbiddenContent } from "docusaurus-roles-plugin/runtime";
+
+export default function ForbiddenBlogPostItem({
+  missingRoles,
+}: {
+  missingRoles: string[];
+}): ReactNode {
+  return (
+    <main className={"container margin-vert--xl"}>
+      <BaseForbiddenContent
+        prefixTranslateId="theme.BlogPostItem.Forbidden"
+        missingRoles={missingRoles}
+      />
+    </main>
+  );
+}

package/src/theme/BlogPostItem/index.tsx

@@ -0,0 +1,22 @@
+import BlogPostItem, { type Props } from "@theme-init/BlogPostItem";
+import RoleGate from "../RoleGate";
+import { getRoleFrontMatter } from "../../options";
+import { useBlogPost } from "@docusaurus/plugin-content-blog/client";
+import ForbiddenBlogPostItem from "./Forbidden";
+
+export default function BlogPostItemWrapper(props: Props) {
+  const { metadata } = useBlogPost();
+  const frontMatter = getRoleFrontMatter(metadata.frontMatter);
+  const requiredRoles = frontMatter.required_roles;
+  const mode = frontMatter.required_roles_mode;
+
+  return (
+    <RoleGate
+      requiredRoles={requiredRoles}
+      mode={mode}
+      forbidden={ForbiddenBlogPostItem}
+    >
+      <BlogPostItem {...props} />
+    </RoleGate>
+  );
+}

package/src/theme/BlogSidebar/index.tsx

@@ -0,0 +1,26 @@
+import { usePluginData } from "@docusaurus/useGlobalData";
+import BlogSidebar, { type Props } from "@theme-init/BlogSidebar";
+import { isAllowed, useRoles } from "docusaurus-roles-plugin/runtime";
+import { type RoleInfo } from "../..";
+
+export default function BlogSidebarWrapper({ sidebar, ...props }: Props) {
+  const plugin = usePluginData("docusaurus-roles-plugin") as {
+    rolesByPermalink: RoleInfo[];
+  };
+  const { roles } = useRoles();
+  if (sidebar) {
+    sidebar.items = sidebar.items.filter((i) => {
+      const roleInfo = plugin.rolesByPermalink.find(
+        (r) => r.permalink === i.permalink,
+      );
+      if (!roleInfo) return true;
+      const { allowed } = isAllowed(
+        roles,
+        roleInfo.requiredRoles,
+        roleInfo.requiredRolesMode,
+      );
+      return allowed;
+    });
+  }
+  return <BlogSidebar {...props} sidebar={sidebar} />;
+}

package/src/theme/DocItem/Forbidden.tsx

@@ -0,0 +1,15 @@
+import { JSX } from "react";
+import { BaseForbiddenContent } from "docusaurus-roles-plugin/runtime";
+
+export default function ForbiddenDocItem({
+  missingRoles,
+}: {
+  missingRoles: string[];
+}): JSX.Element {
+  return (
+    <BaseForbiddenContent
+      prefixTranslateId="theme.DocItem.Forbidden"
+      missingRoles={missingRoles}
+    />
+  );
+}

package/src/theme/DocItem/index.tsx

@@ -0,0 +1,20 @@
+import DocItem, { type Props } from "@theme-init/DocItem";
+import RoleGate from "../RoleGate";
+import { getRoleFrontMatter } from "../../options";
+import ForbiddenDocItem from "./Forbidden";
+
+export default function DocItemWrapper(props: Props) {
+  const frontMatter = getRoleFrontMatter(props?.content.frontMatter);
+  const requiredRoles = frontMatter.required_roles;
+  const mode = frontMatter.required_roles_mode;
+
+  return (
+    <RoleGate
+      requiredRoles={requiredRoles}
+      mode={mode}
+      forbidden={ForbiddenDocItem}
+    >
+      <DocItem {...props} />
+    </RoleGate>
+  );
+}