zudoku 0.53.5 → 0.54.0

package/src/lib/components/context/ZudokuContext.ts

@@ -2,7 +2,6 @@ import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import { createContext, useContext } from "react";
 import { matchPath, useLocation } from "react-router";
 import { type NavigationItem } from "../../../config/validators/NavigationSchema.js";
-import { useAuth } from "../../authentication/hook.js";
 import type { ZudokuContext } from "../../core/ZudokuContext.js";
 import { joinUrl } from "../../util/joinUrl.js";
 import { CACHE_KEYS } from "../cache.js";
@@ -45,14 +44,28 @@ const getItemPath = (item: NavigationItem) => {
       return undefined;
   }
 };
+
+const extractAllPaths = (items: NavigationItem[]) => {
+  const paths = new Set<string>();
+
+  const collectPaths = (items: NavigationItem[]) => {
+    for (const item of items) {
+      const itemPath = getItemPath(item)?.split("?").at(0)?.split("#").at(0);
+
+      if (itemPath) paths.add(itemPath);
+      if (item.type === "category") {
+        collectPaths(item.items);
+      }
+    }
+  };
+  collectPaths(items);
+
+  return [...paths];
+};
+
 export const useCurrentNavigation = () => {
-  const { getPluginNavigation, navigation, options } = useZudoku();
+  const { getPluginNavigation, navigation } = useZudoku();
   const location = useLocation();
-  const auth = useAuth();
-
-  const isProtectedRoute = options.protectedRoutes?.some((route) =>
-    matchPath(route, location.pathname),
-  );
 
   const navItem = traverseNavigation(navigation, (item, parentCategories) => {
     if (getItemPath(item) === location.pathname) {
@@ -67,12 +80,8 @@ export const useCurrentNavigation = () => {
 
   let topNavItem = navItem;
   if (!navItem && data.length > 0) {
-    // Extract base paths from plugin navigation items
-    const pluginBasePaths = data.flatMap((item) => {
-      return getItemPath(item)?.split("?").at(0)?.split("#").at(0) ?? [];
-    });
+    const pluginBasePaths = extractAllPaths(data);
 
-    // Find top-level nav item that matches any plugin base path
     topNavItem = navigation
       .flatMap((item) => {
         const itemPath = getItemPath(item);
@@ -88,13 +97,11 @@ export const useCurrentNavigation = () => {
       })?.item;
   }
 
-  const hasNavigation =
-    auth.isAuthEnabled && !auth.isAuthenticated && isProtectedRoute;
-
   return {
-    navigation: hasNavigation
-      ? []
-      : [...(navItem?.type === "category" ? navItem.items : []), ...data],
+    navigation: [
+      ...(navItem?.type === "category" ? navItem.items : []),
+      ...data,
+    ],
     topNavItem,
   };
 };

package/src/lib/components/navigation/NavigationItem.tsx

@@ -9,13 +9,15 @@ import {
   TooltipTrigger,
 } from "zudoku/ui/Tooltip.js";
 import type { NavigationItem as NavigationItemType } from "../../../config/validators/NavigationSchema.js";
+import { useAuth } from "../../authentication/hook.js";
 import { cn } from "../../util/cn.js";
 import { joinUrl } from "../../util/joinUrl.js";
 import { AnchorLink } from "../AnchorLink.js";
 import { useViewportAnchor } from "../context/ViewportAnchorContext.js";
+import { useZudoku } from "../context/ZudokuContext.js";
 import { NavigationBadge } from "./NavigationBadge.js";
 import { NavigationCategory } from "./NavigationCategory.js";
-import { navigationListItem } from "./utils.js";
+import { isHiddenItem, navigationListItem } from "./utils.js";
 
 const TruncatedLabel = ({
   label,
@@ -74,6 +76,12 @@ export const NavigationItem = ({
 }) => {
   const location = useLocation();
   const { activeAnchor } = useViewportAnchor();
+  const auth = useAuth();
+  const context = useZudoku();
+
+  if (!isHiddenItem(auth, context)(item)) {
+    return null;
+  }
 
   switch (item.type) {
     case "category":

package/src/lib/components/navigation/utils.ts

@@ -4,6 +4,8 @@ import type {
   NavigationCategory,
   NavigationItem,
 } from "../../../config/validators/NavigationSchema.js";
+import type { UseAuthReturn } from "../../authentication/hook.js";
+import type { ZudokuContext } from "../../core/ZudokuContext.js";
 import { joinUrl } from "../../util/joinUrl.js";
 import { useCurrentNavigation } from "../context/ZudokuContext.js";
 
@@ -133,14 +135,18 @@ export const navigationListItem = cva(
 );
 
 export const isHiddenItem =
-  (isAuthenticated?: boolean) =>
+  (auth: UseAuthReturn, context: ZudokuContext) =>
   (item: NavigationItem): boolean => {
+    if (typeof item.display === "function") {
+      return item.display({ context, auth });
+    }
+
     if (item.display === "hide") return false;
     if (!item.label) return false;
 
     return (
-      (item.display === "auth" && isAuthenticated) ||
-      (item.display === "anon" && !isAuthenticated) ||
+      (item.display === "auth" && auth.isAuthenticated) ||
+      (item.display === "anon" && !auth.isAuthenticated) ||
       !item.display ||
       item.display === "always"
     );

package/src/lib/core/RouteGuard.tsx

@@ -24,14 +24,18 @@ export const RouteGuard = () => {
   const location = useLocation();
   const latestPath = useLatest(location.pathname);
   const shouldBypass = use(BypassProtectedRoutesContext);
+  const { protectedRoutes } = zudoku.options;
 
-  const { protectedRoutes = [] } = zudoku.options;
+  const authCheckFn =
+    !shouldBypass && protectedRoutes
+      ? Object.entries(protectedRoutes).find(([path]) =>
+          matchPath({ path, end: true }, location.pathname),
+        )?.[1]
+      : undefined;
 
-  const isProtected =
-    !shouldBypass &&
-    protectedRoutes.some((path) =>
-      matchPath({ path, end: true }, location.pathname),
-    );
+  const isProtectedRoute = authCheckFn !== undefined;
+  const needsToSignIn =
+    isProtectedRoute && !authCheckFn({ auth, context: zudoku });
 
   useQuery({
     queryKey: ["login-redirect"],
@@ -42,14 +46,10 @@ export const RouteGuard = () => {
       });
       return true;
     },
-    enabled:
-      typeof window !== "undefined" &&
-      isProtected &&
-      !auth.isPending &&
-      !auth.isAuthenticated,
+    enabled: typeof window !== "undefined" && needsToSignIn && !auth.isPending,
   });
 
-  if (isProtected && !auth.isAuthenticated) {
+  if (needsToSignIn) {
     return (
       <Dialog
         open={true}
@@ -71,7 +71,7 @@ export const RouteGuard = () => {
     );
   }
 
-  if (isProtected && !auth.isAuthEnabled) {
+  if (isProtectedRoute && !auth.isAuthEnabled) {
     throw new ZudokuError("Authentication is not enabled", {
       title: "Authentication is not enabled",
       developerHint:

package/src/lib/core/ZudokuContext.ts

@@ -5,6 +5,10 @@ import type { Location } from "react-router";
 import type { BundledTheme, HighlighterCore } from "shiki";
 import type { z } from "zod/v4";
 import type { Navigation } from "../../config/validators/NavigationSchema.js";
+import {
+  type ProtectedRoutesInput,
+  ProtectedRoutesSchema,
+} from "../../config/validators/ProtectedRoutesSchema.js";
 import type { FooterSchema } from "../../config/validators/validate.js";
 import type { AuthenticationPlugin } from "../authentication/authentication.js";
 import { type AuthState, useAuthState } from "../authentication/state.js";
@@ -94,7 +98,7 @@ export type ZudokuContextOptions = {
     components?: MdxComponentsType;
   };
   overrides?: ComponentsContextType;
-  protectedRoutes?: string[];
+  protectedRoutes?: ProtectedRoutesInput;
   syntaxHighlighting?: {
     highlighter: HighlighterCore;
     themes?: { light: BundledTheme; dark: BundledTheme };
@@ -113,12 +117,21 @@ export class ZudokuContext {
   private emitter = createNanoEvents<ZudokuEvents>();
 
   constructor(options: ZudokuContextOptions, queryClient: QueryClient) {
-    const protectedRoutes = (options.protectedRoutes ?? []).concat(
-      options.plugins?.flatMap((plugin) =>
-        isNavigationPlugin(plugin) ? (plugin.getProtectedRoutes?.() ?? []) : [],
-      ) ?? [],
+    const pluginProtectedRoutes = Object.fromEntries(
+      (options.plugins ?? []).flatMap((plugin) => {
+        if (!isNavigationPlugin(plugin)) return [];
+        const routes = plugin.getProtectedRoutes?.();
+        if (!routes) return [];
+
+        return Object.entries(ProtectedRoutesSchema.parse(routes) ?? {});
+      }),
     );
 
+    const protectedRoutes = {
+      ...pluginProtectedRoutes,
+      ...ProtectedRoutesSchema.parse(options.protectedRoutes),
+    };
+
     this.queryClient = queryClient;
     this.options = { ...options, protectedRoutes };
     this.plugins = options.plugins ?? [];

package/src/lib/core/plugins.ts

@@ -2,6 +2,7 @@ import type { LucideIcon } from "lucide-react";
 import type { ReactElement } from "react";
 import type { Location, RouteObject } from "react-router";
 import type { Navigation } from "../../config/validators/NavigationSchema.js";
+import type { ProtectedRoutesInput } from "../../config/validators/ProtectedRoutesSchema.js";
 import type { AuthenticationPlugin } from "../authentication/authentication.js";
 import type { MdxComponentsType } from "../util/MdxComponents.js";
 import type {
@@ -24,7 +25,7 @@ export type { AuthenticationPlugin, RouteObject };
 export interface NavigationPlugin {
   getRoutes: () => RouteObject[];
   getNavigation?: (path: string, context: ZudokuContext) => Promise<Navigation>;
-  getProtectedRoutes?: () => string[];
+  getProtectedRoutes?: () => ProtectedRoutesInput;
 }
 
 export const createApiIdentityPlugin = (

package/src/lib/plugins/api-keys/CreateApiKey.tsx

@@ -2,6 +2,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query";
 import { useForm } from "react-hook-form";
 import { useNavigate } from "react-router";
 import { ActionButton } from "zudoku/ui/ActionButton.js";
+import { Alert, AlertDescription, AlertTitle } from "zudoku/ui/Alert.js";
 import { DialogClose, DialogFooter } from "zudoku/ui/Dialog.js";
 import {
   Select,
@@ -33,6 +34,7 @@ export const CreateApiKey = ({
       expiresOn: "30",
     },
   });
+
   const createKeyMutation = useMutation({
     mutationFn: ({ description, expiresOn }: CreateApiKey) => {
       if (!service.createKey) {
@@ -43,7 +45,10 @@ export const CreateApiKey = ({
         expiresOn !== "never" ? addDaysToDate(Number(expiresOn)) : undefined;
 
       return service.createKey(
-        { description: description || "Secret Key", expiresOn: expiresOnDate },
+        {
+          description: description || "Secret Key",
+          expiresOn: expiresOnDate,
+        },
         context,
       );
     },
@@ -68,6 +73,12 @@ export const CreateApiKey = ({
         ),
       )}
     >
+      {createKeyMutation.error && (
+        <Alert variant="destructive" className="mb-4">
+          <AlertTitle>Error</AlertTitle>
+          <AlertDescription>{createKeyMutation.error.message}</AlertDescription>
+        </Alert>
+      )}
       <div className="flex gap-2 flex-col text-sm font-medium">
         Name
         <Input {...form.register("description")} />

package/src/lib/plugins/api-keys/SettingsApiKeys.tsx

@@ -35,6 +35,7 @@ import { Button } from "../../ui/Button.js";
 import { Input } from "../../ui/Input.js";
 import { cn } from "../../util/cn.js";
 import { useCopyToClipboard } from "../../util/useCopyToClipboard.js";
+import { CreateApiKey } from "./CreateApiKey.js";
 import { type ApiConsumer, type ApiKey, type ApiKeyService } from "./index.js";
 
 export const SettingsApiKeys = ({ service }: { service: ApiKeyService }) => {
@@ -50,6 +51,8 @@ export const SettingsApiKeys = ({ service }: { service: ApiKeyService }) => {
     retry: false,
   });
 
+  const [isCreateApiKeyOpen, setIsCreateApiKeyOpen] = useState(false);
+
   const deleteKeyMutation = useMutation({
     mutationFn: ({
       consumerId,
@@ -180,11 +183,28 @@ export const SettingsApiKeys = ({ service }: { service: ApiKeyService }) => {
       <Slot.Target name="api-keys-list-page" />
 
       <div className="flex justify-between pb-3">
-        <h1 className="font-medium text-2xl">API Keys</h1>
+        <h1 className="font-medium text-2xl">
+          API Keys {typeof service.createKey}
+        </h1>
+
         {service.createKey && (
-          <Button asChild>
-            <Link to="/settings/api-keys/new">Create API Key</Link>
-          </Button>
+          <Dialog
+            open={isCreateApiKeyOpen}
+            onOpenChange={setIsCreateApiKeyOpen}
+          >
+            <DialogTrigger asChild>
+              <Button variant="outline">Create API Key</Button>
+            </DialogTrigger>
+            <DialogContent>
+              <DialogHeader>
+                <DialogTitle>Create API Key</DialogTitle>
+              </DialogHeader>
+              <CreateApiKey
+                service={service}
+                onOpenChange={setIsCreateApiKeyOpen}
+              />
+            </DialogContent>
+          </Dialog>
         )}
       </div>
       <p>Create, manage, and monitor your API keys</p>

package/src/lib/plugins/api-keys/index.tsx

@@ -27,7 +27,7 @@ export type ApiKeyService = {
   ) => Promise<void>;
   getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
   createKey?: (
-    apiKey: { description: string; expiresOn?: string },
+    apiKey: { description: string; expiresOn?: string; expiresValue?: string },
     context: ZudokuContext,
   ) => Promise<void>;
 };
@@ -74,7 +74,10 @@ const throwIfProblemJson = async (response: Response) => {
   }
 };
 
-const createDefaultHandler = (deploymentName: string): ApiKeyService => {
+const createDefaultHandler = (
+  deploymentName: string,
+  options: ApiKeyPluginOptions,
+): ApiKeyService => {
   return {
     deleteKey: async (consumerId, keyId, context) => {
       const request = new Request(
@@ -159,6 +162,7 @@ const createDefaultHandler = (deploymentName: string): ApiKeyService => {
         key: consumer.apiKeys.data.at(0),
       }));
     },
+    ...options,
   };
 };
 
@@ -170,7 +174,7 @@ export const apiKeyPlugin = (
 ): ZudokuPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
   const service: ApiKeyService =
     "deploymentName" in options
-      ? createDefaultHandler(options.deploymentName)
+      ? createDefaultHandler(options.deploymentName, options)
       : options;
 
   return {
@@ -203,7 +207,6 @@ export const apiKeyPlugin = (
       }
     },
     getRoutes: (): RouteObject[] => {
-      // TODO: Make lazy
       return [
         {
           element: <ProtectedRoute />,
@@ -213,10 +216,6 @@ export const apiKeyPlugin = (
               path: "/settings/api-keys",
               element: <SettingsApiKeys service={service} />,
             },
-            // {
-            //   path: "/settings/api-keys/new",
-            //   element: <CreateApiKey service={service} />,
-            // },
           ],
         },
       ];

package/src/lib/plugins/openapi/graphql/gql.ts

@@ -19,7 +19,7 @@ type Documents = {
   "\n  query OperationsForTag(\n    $input: JSON!\n    $type: SchemaType!\n    $tag: String\n    $untagged: Boolean\n  ) {\n    schema(input: $input, type: $type) {\n      servers {\n        url\n      }\n      description\n      summary\n      title\n      url\n      version\n      tag(slug: $tag, untagged: $untagged) {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n        next {\n          name\n          slug\n        }\n        prev {\n          name\n          slug\n        }\n      }\n    }\n  }\n": typeof types.OperationsForTagDocument;
   "\n  query GetSchemas($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      title\n      description\n      summary\n      components {\n        schemas {\n          name\n          schema\n          extensions\n        }\n      }\n    }\n  }\n": typeof types.GetSchemasDocument;
   "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n": typeof types.GetServerQueryDocument;
-  "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n": typeof types.GetNavigationOperationsDocument;
+  "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      extensions\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n": typeof types.GetNavigationOperationsDocument;
 };
 const documents: Documents = {
   "\n  query ServersQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n":
@@ -34,7 +34,7 @@ const documents: Documents = {
     types.GetSchemasDocument,
   "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n":
     types.GetServerQueryDocument,
-  "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n":
+  "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      extensions\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n":
     types.GetNavigationOperationsDocument,
 };
 
@@ -78,7 +78,7 @@ export function graphql(
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n",
+  source: "\n  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      extensions\n      tags {\n        slug\n        name\n        extensions\n        operations {\n          summary\n          slug\n          method\n          operationId\n          path\n        }\n      }\n      components {\n        schemas {\n          __typename\n        }\n      }\n    }\n  }\n",
 ): typeof import("./graphql.js").GetNavigationOperationsDocument;
 
 export function graphql(source: string) {

package/src/lib/plugins/openapi/graphql/graphql.ts

@@ -383,6 +383,7 @@ export type GetNavigationOperationsQuery = {
   __typename?: "Query";
   schema: {
     __typename?: "Schema";
+    extensions?: any | null;
     tags: Array<{
       __typename?: "SchemaTag";
       slug?: string | null;
@@ -645,6 +646,7 @@ export const GetServerQueryDocument = new TypedDocumentString(`
 export const GetNavigationOperationsDocument = new TypedDocumentString(`
     query GetNavigationOperations($input: JSON!, $type: SchemaType!) {
   schema(input: $input, type: $type) {
+    extensions
     tags {
       slug
       name

package/src/lib/plugins/openapi/index.tsx

@@ -1,6 +1,7 @@
 import { CirclePlayIcon, LogInIcon } from "lucide-react";
 import { type ReactNode } from "react";
 import { matchPath } from "react-router";
+import type { NavigationItem } from "../../../config/validators/NavigationSchema.js";
 import { useAuth } from "../../authentication/hook.js";
 import { type ZudokuPlugin } from "../../core/plugins.js";
 import { Button } from "../../ui/Button.js";
@@ -18,6 +19,7 @@ import { getRoutes, getVersions } from "./util/getRoutes.js";
 export const GetNavigationOperationsQuery = graphql(`
   query GetNavigationOperations($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
+      extensions
       tags {
         slug
         name
@@ -139,25 +141,73 @@ export const openApiPlugin = (config: OasPluginConfig): ZudokuPlugin => {
         });
         const data = await context.queryClient.ensureQueryData(query);
 
-        const categories = data.schema.tags.flatMap((tag) => {
-          if (!tag.name || tag.operations.length === 0) return [];
+        const tagCategories = new Map(
+          data.schema.tags
+            .filter((tag) => tag.name && tag.operations.length > 0)
+            .map((tag) => {
+              if (!tag.name) {
+                throw new Error(`Tag ${tag.slug} has no name`);
+              }
+
+              const categoryPath = joinUrl(basePath, versionParam, tag.slug);
+
+              const isCollapsed =
+                tag.extensions?.["x-zudoku-collapsed"] ??
+                !config.options?.expandAllTags;
+              const isCollapsible =
+                tag.extensions?.["x-zudoku-collapsible"] ?? true;
+
+              return [
+                tag.name,
+                createNavigationCategory({
+                  label: tag.name,
+                  path: categoryPath,
+                  operations: tag.operations,
+                  collapsed: isCollapsed,
+                  collapsible: isCollapsible,
+                }),
+              ];
+            }),
+        );
 
-          const categoryPath = joinUrl(basePath, versionParam, tag.slug);
+        const tagGroups =
+          (data.schema.extensions?.["x-tagGroups"] as
+            | { name: string; tags: string[] }[]
+            | undefined) ?? [];
 
-          const isCollapsed =
-            tag.extensions?.["x-zudoku-collapsed"] ??
-            !config.options?.expandAllTags;
-          const isCollapsible =
-            tag.extensions?.["x-zudoku-collapsible"] ?? true;
+        const groupedTags = new Set(
+          tagGroups.flatMap((group) =>
+            group.tags.filter((name) => tagCategories.has(name)),
+          ),
+        );
 
-          return createNavigationCategory({
-            label: tag.name,
-            path: categoryPath,
-            operations: tag.operations,
-            collapsed: isCollapsed,
-            collapsible: isCollapsible,
-          });
-        });
+        const groupedCategories: NavigationItem[] = tagGroups.flatMap(
+          (group) => {
+            const items = group.tags
+              .map((name) => tagCategories.get(name))
+              .filter(Boolean) as NavigationItem[];
+
+            if (items.length === 0) {
+              return [];
+            }
+            return [
+              {
+                type: "category",
+                label: group.name,
+                items,
+                collapsible: true,
+                collapsed: !config.options?.expandAllTags,
+              },
+            ];
+          },
+        );
+
+        const categories: NavigationItem[] = [
+          ...groupedCategories,
+          ...Array.from(tagCategories.entries())
+            .filter(([name]) => !groupedTags.has(name))
+            .map(([, cat]) => cat),
+        ];
 
         const untaggedOperations = data.schema.tags.find(
           (tag) => !tag.name,

package/src/lib/ui/ActionButton.tsx

@@ -19,7 +19,9 @@ export const ActionButton = forwardRef<HTMLButtonElement, ActionButtonProps>(
             <Spinner />
           </div>
         )}
-        <div className={cn(isPending && "invisible")}>{children}</div>
+        <span className={cn("block", isPending && "invisible")}>
+          {children}
+        </span>
       </Button>
     );
   },

package/src/lib/util/invariant.ts

@@ -18,17 +18,19 @@ export default function invariant(
   throw new ZudokuError(provided ?? "Invariant failed");
 }
 
+export type ZudokuErrorOptions = {
+  developerHint?: string;
+  title?: string;
+  cause?: Error;
+};
+
 export class ZudokuError extends Error {
   public developerHint: string | undefined;
   public title: string | undefined;
 
   constructor(
     message: string,
-    {
-      developerHint,
-      title,
-      cause,
-    }: { developerHint?: string; title?: string; cause?: Error } = {},
+    { developerHint, title, cause }: ZudokuErrorOptions = {},
   ) {
     super(message, { cause });
     this.name = "ZudokuError";