zudoku 0.0.0-ff3751f → 0.0.0-fix-display-option-navigation-items.4bdfe991

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

@@ -1,37 +1,40 @@
-import { type RouteObject } from "react-router-dom";
-import { DevPortalContext } from "../../core/DevPortalContext.js";
+import { KeyRoundIcon } from "lucide-react";
+import { type RouteObject } from "react-router";
+import { type ZudokuContext } from "../../core/ZudokuContext.js";
 import {
   type ApiIdentityPlugin,
-  type DevPortalPlugin,
-  ProfileMenuPlugin,
+  type ProfileMenuPlugin,
+  type ZudokuPlugin,
 } from "../../core/plugins.js";
 import { RouterError } from "../../errors/RouterError.js";
 import invariant from "../../util/invariant.js";
-import { CreateApiKey } from "./CreateApiKey.js";
 import { ProtectedRoute } from "./ProtectedRoute.js";
 import { SettingsApiKeys } from "./SettingsApiKeys.js";
 
-const DEFAULT_API_KEY_ENDPOINT =
-  "https://zudoku-rewiringamerica-main-ef9c9c0.d2.zuplo.dev";
+const DEFAULT_API_KEY_ENDPOINT = "https://api.zuploedge.com/v2/client";
 
 export type ApiKeyService = {
-  getKeys: (context: DevPortalContext) => Promise<ApiKey[]>;
-  rollKey?: (id: string, context: DevPortalContext) => Promise<void>;
-  deleteKey?: (id: string, context: DevPortalContext) => Promise<void>;
-  updateKeyDescription?: (
-    apiKey: { id: string; description: string },
-    context: DevPortalContext,
+  getConsumers: (context: ZudokuContext) => Promise<ApiConsumer[]>;
+  rollKey?: (consumerId: string, context: ZudokuContext) => Promise<void>;
+  deleteKey?: (
+    consumerId: string,
+    keyId: string,
+    context: ZudokuContext,
   ) => Promise<void>;
-  getUsage?: (apiKeys: string[], context: DevPortalContext) => Promise<void>;
+  updateConsumer?: (
+    consumer: { id: string; label?: string },
+    context: ZudokuContext,
+  ) => Promise<void>;
+  getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
   createKey?: (
     apiKey: { description: string; expiresOn?: string },
-    context: DevPortalContext,
+    context: ZudokuContext,
   ) => Promise<void>;
 };
 
-export type GetApiKeysOptions = ApiKeyService | { endpoint: string } | object;
-
-export type ApiKeyPluginOptions = object & GetApiKeysOptions;
+export type ApiKeyPluginOptions =
+  | ApiKeyService
+  | ({ deploymentName: string } & Partial<ApiKeyService>);
 
 export interface ApiKey {
   id: string;
@@ -42,82 +45,158 @@ export interface ApiKey {
   key: string;
 }
 
-const createDefaultHandler = (endpoint: string): ApiKeyService => {
-  return {
-    deleteKey: async (id, context) => {
-      const request = new Request(endpoint + `/v1/developer/api-keys/${id}`, {
-        method: "DELETE",
-      });
+export interface ApiConsumer {
+  id: string;
+  label: string;
+  apiKeys: ApiKey[];
+  description?: string;
+  createdOn?: string;
+  updatedOn?: string;
+  expiresOn?: string;
+  key?: ApiKey;
+}
 
-      await context.signRequest(request);
+const parseJsonSafe = async (response: Response) => {
+  try {
+    return await response.json();
+  } catch {
+    return;
+  }
+};
 
+const throwIfProblemJson = async (response: Response) => {
+  const contentType = response.headers.get("content-type");
+  if (!response.ok && contentType?.includes("application/problem+json")) {
+    const data = await parseJsonSafe(response);
+    if (data.type && data.title) {
+      throw new Error(data.detail ?? data.title);
+    }
+  }
+};
+
+const createDefaultHandler = (deploymentName: string): ApiKeyService => {
+  return {
+    deleteKey: async (consumerId, keyId, context) => {
+      const request = new Request(
+        DEFAULT_API_KEY_ENDPOINT +
+          `/${deploymentName}/consumers/${consumerId}/keys/${keyId}`,
+        {
+          method: "DELETE",
+        },
+      );
+      await context.signRequest(request);
       const response = await fetch(request);
+      await throwIfProblemJson(response);
       invariant(response.ok, "Failed to delete API key");
     },
-    rollKey: async (id, context) => {
+    updateConsumer: async (consumer, context) => {
       const response = await fetch(
         await context.signRequest(
-          new Request(endpoint + `/v1/developer/api-keys/${id}/key`, {
-            method: "DELETE",
-          }),
+          new Request(
+            DEFAULT_API_KEY_ENDPOINT +
+              `/${deploymentName}/consumers/${consumer.id}`,
+            {
+              method: "PATCH",
+              headers: {
+                "Content-Type": "application/json",
+              },
+              body: JSON.stringify({
+                label: consumer.label,
+              }),
+            },
+          ),
         ),
       );
-      invariant(response.ok, "Failed to delete API key");
+      await throwIfProblemJson(response);
+      invariant(response.ok, "Failed to update API key description");
     },
-    createKey: async (apiKey, context) => {
-      const request = new Request(endpoint + `/v1/developer/api-keys`, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(apiKey),
-      });
-
-      await context.signRequest(request);
-
-      const response = await fetch(request);
-      invariant(response.ok, "Failed to create API key");
+    rollKey: async (consumerId, context) => {
+      const response = await fetch(
+        await context.signRequest(
+          new Request(
+            DEFAULT_API_KEY_ENDPOINT +
+              `/${deploymentName}/consumers/${consumerId}/roll-key`,
+            {
+              method: "POST",
+              headers: {
+                "Content-Type": "application/json",
+              },
+              body: JSON.stringify({}),
+            },
+          ),
+        ),
+      );
+      await throwIfProblemJson(response);
+      invariant(response.ok, "Failed to delete API key");
     },
-    getKeys: async (context) => {
-      const request = new Request(endpoint + `/v1/developer/api-keys`);
-
+    getConsumers: async (context) => {
+      const request = new Request(
+        DEFAULT_API_KEY_ENDPOINT + `/${deploymentName}/consumers`,
+      );
       await context.signRequest(request);
 
       const keys = await fetch(request);
+      await throwIfProblemJson(keys);
       invariant(keys.ok, "Failed to fetch API keys");
 
-      return await keys.json();
+      const data = (await keys.json()) as {
+        data: [
+          {
+            id: string;
+            label?: string;
+            subject?: string;
+            apiKeys: {
+              data: ApiKey[];
+            };
+          },
+        ];
+      };
+
+      return data.data.map((consumer) => ({
+        id: consumer.id,
+        label: consumer.label || consumer.subject || "API Key",
+        apiKeys: consumer.apiKeys.data,
+        key: consumer.apiKeys.data.at(0),
+      }));
     },
   };
 };
 
+export const createApiKeyService = <T extends ApiKeyService>(service: T): T =>
+  service;
+
 export const apiKeyPlugin = (
   options: ApiKeyPluginOptions,
-): DevPortalPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
-  const endpoint =
-    "endpoint" in options ? options.endpoint : DEFAULT_API_KEY_ENDPOINT;
-
-  const service =
-    "getKeys" in options ? options : createDefaultHandler(endpoint);
+): ZudokuPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
+  const service: ApiKeyService =
+    "deploymentName" in options
+      ? createDefaultHandler(options.deploymentName)
+      : options;
 
   return {
     getProfileMenuItems: () => [
       {
         label: "API Keys",
         path: "/settings/api-keys",
+        category: "middle",
+        icon: KeyRoundIcon,
       },
     ],
+
     getIdentities: async (context) => {
       try {
-        const keys = await service.getKeys(context);
+        const consumers = await service.getConsumers(context);
 
-        return keys.map((key) => ({
+        return consumers.map((consumer) => ({
           authorizeRequest: (request) => {
-            request.headers.set("Authorization", `Bearer ${key.key}`);
+            request.headers.set(
+              "Authorization",
+              `Bearer ${consumer.apiKeys.at(0)?.key}`,
+            );
             return request;
           },
-          id: key.id,
-          label: key.description ?? key.id,
+          id: consumer.id,
+          label: consumer.label,
         }));
       } catch {
         return [];
@@ -134,10 +213,10 @@ export const apiKeyPlugin = (
               path: "/settings/api-keys",
               element: <SettingsApiKeys service={service} />,
             },
-            {
-              path: "/settings/api-keys/new",
-              element: <CreateApiKey service={service} />,
-            },
+            // {
+            //   path: "/settings/api-keys/new",
+            //   element: <CreateApiKey service={service} />,
+            // },
           ],
         },
       ];

package/src/lib/plugins/custom-pages/index.tsx

@@ -1,24 +1,29 @@
-import { type ComponentType, type ReactNode } from "react";
-import type { RouteObject } from "react-router-dom";
-import { type ExposedComponentProps } from "../../components/SlotletProvider.js";
-import type { DevPortalPlugin, NavigationPlugin } from "../../core/plugins.js";
-import { CustomPage } from "./CustomPage.js";
+import { type ReactNode } from "react";
+import type { RouteObject } from "react-router";
+import type { NavigationItem } from "../../../config/validators/NavigationSchema.js";
+import { traverseNavigation } from "../../components/navigation/utils.js";
+import type { NavigationPlugin } from "../../core/plugins.js";
 
 export type CustomPageConfig = {
   path: string;
-  prose?: boolean;
   element?: ReactNode;
-  render?: ComponentType<ExposedComponentProps>;
 };
 
 export const customPagesPlugin = (
-  config: CustomPageConfig[],
-): DevPortalPlugin & NavigationPlugin => {
-  return {
-    getRoutes: (): RouteObject[] =>
-      config.map(({ path, ...props }) => ({
-        path,
-        element: <CustomPage {...props} />,
-      })),
-  };
-};
+  navigation: NavigationItem[] = [],
+): NavigationPlugin => ({
+  getRoutes: (): RouteObject[] => {
+    const customPages: RouteObject[] = [];
+
+    traverseNavigation(navigation, (item) => {
+      if (item.type === "custom-page") {
+        customPages.push({
+          path: item.path,
+          element: item.element,
+        });
+      }
+    });
+
+    return customPages;
+  },
+});

package/src/lib/plugins/markdown/MdxPage.tsx

@@ -1,28 +1,37 @@
 import { useMDXComponents } from "@mdx-js/react";
 import slugify from "@sindresorhus/slugify";
 import { Helmet } from "@zudoku/react-helmet-async";
-import { type PropsWithChildren } from "react";
-import { Link } from "react-router-dom";
+import { EditIcon } from "lucide-react";
+import { type PropsWithChildren, useEffect } from "react";
+import { Button } from "zudoku/ui/Button.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
-import { ProseClasses } from "../../components/Markdown.js";
+import { Pagination } from "../../components/Pagination.js";
+import { Typography } from "../../components/Typography.js";
+import { Toc } from "../../components/navigation/Toc.js";
 import {
   useCurrentItem,
   usePrevNext,
 } from "../../components/navigation/utils.js";
 import type { MdxComponentsType } from "../../util/MdxComponents.js";
-import { cn } from "../../util/cn.js";
-import { Toc } from "./Toc.js";
-import { MarkdownPluginDefaultOptions, MDXImport } from "./index.js";
+import { type MarkdownPluginDefaultOptions, type MDXImport } from "./index.js";
+
+declare global {
+  interface Window {
+    __getReactRefreshIgnoredExports?: (args: {
+      id: string;
+    }) => string[] | undefined;
+  }
+}
 
 const MarkdownHeadings = {
   h2: ({ children, id }) => (
-    <Heading level={2} id={id} registerSidebarAnchor>
+    <Heading level={2} id={id} registerNavigationAnchor>
       {children}
     </Heading>
   ),
   h3: ({ children, id }) => (
-    <Heading level={3} id={id} registerSidebarAnchor>
+    <Heading level={3} id={id} registerNavigationAnchor>
       {children}
     </Heading>
   ),
@@ -32,7 +41,9 @@ export const MdxPage = ({
   mdxComponent: MdxComponent,
   frontmatter = {},
   defaultOptions,
+  __filepath,
   tableOfContents,
+  excerpt,
 }: PropsWithChildren<
   Omit<MDXImport, "default"> & {
     mdxComponent: MDXImport["default"];
@@ -40,13 +51,34 @@ export const MdxPage = ({
   }
 >) => {
   const categoryTitle = useCurrentItem()?.categoryLabel;
+
   const title = frontmatter.title;
+  const description = frontmatter.description ?? excerpt;
   const category = frontmatter.category ?? categoryTitle;
   const hideToc = frontmatter.toc === false || defaultOptions?.toc === false;
   const pageTitle =
-    tableOfContents.find((item) => item.depth === 1)?.value ?? title;
+    title ?? tableOfContents.find((item) => item.depth === 1)?.value;
   const hidePager =
-    frontmatter.disablePager ?? defaultOptions?.disablePager ?? false;
+    frontmatter.disable_pager ??
+    frontmatter.disablePager ??
+    defaultOptions?.disablePager ??
+    false;
+
+  const showLastModified =
+    frontmatter.showLastModified ?? defaultOptions?.showLastModified ?? true;
+
+  const lastModifiedDate = frontmatter.lastModifiedTime
+    ? new Date(frontmatter.lastModifiedTime)
+    : null;
+
+  const editConfig =
+    frontmatter.suggestEdit !== false &&
+    (frontmatter.suggestEdit ?? defaultOptions?.suggestEdit);
+
+  const editUrl = editConfig
+    ? editConfig.url.replaceAll("{filePath}", __filepath)
+    : null;
+  const editText = editConfig ? editConfig.text || "Edit this page" : null;
 
   const tocEntries =
     tableOfContents.find((item) => item.depth === 1)?.children ??
@@ -57,17 +89,31 @@ export const MdxPage = ({
 
   const { prev, next } = usePrevNext();
 
+  useEffect(() => {
+    if (process.env.NODE_ENV === "development") {
+      window.__getReactRefreshIgnoredExports = ({ id }) => {
+        if (!id.endsWith(__filepath)) return;
+
+        return ["frontmatter", "tableOfContents"];
+      };
+
+      return () => {
+        window.__getReactRefreshIgnoredExports = undefined;
+      };
+    }
+  }, [__filepath]);
+
   return (
-    <div className="xl:grid grid-cols-[--sidecar-grid-cols] gap-8 justify-between">
+    <div
+      className="grid grid-cols-1 xl:grid-cols-(--sidecar-grid-cols) gap-8 justify-between"
+      data-pagefind-filter="section:markdown"
+      data-pagefind-meta="section:markdown"
+    >
       <Helmet>
         <title>{pageTitle}</title>
+        {description && <meta name="description" content={description} />}
       </Helmet>
-      <div
-        className={cn(
-          ProseClasses,
-          "max-w-full xl:w-full xl:max-w-prose flex-1 flex-shrink pt-[--padding-content-top] pb-[--padding-content-bottom]",
-        )}
-      >
+      <Typography className="max-w-full xl:w-full xl:max-w-3xl flex-1 shrink pt-(--padding-content-top)">
         {(category || title) && (
           <header>
             {category && <CategoryHeading>{category}</CategoryHeading>}
@@ -81,47 +127,58 @@ export const MdxPage = ({
         <MdxComponent
           components={{ ...useMDXComponents(), ...MarkdownHeadings }}
         />
-        {!hidePager && (
-          <>
-            <hr />
-            <div className="not-prose flex flex-wrap items-center justify-between gap-2 lg:gap-8">
-              {prev ? (
-                <Link
-                  to={prev.id}
-                  className="flex flex-col items-stretch gap-2 flex-1 min-w-max border rounded px-6 py-4 text-start hover:border-primary/85 transition shadow-sm hover:shadow-md"
-                  title={prev.label}
-                >
-                  <div className="text-sm text-muted-foreground">
-                    ← Previous page
-                  </div>
-                  <div className="text-lg text-primary truncate">
-                    {prev.label}
-                  </div>
-                </Link>
-              ) : (
-                <div className="flex-1" />
-              )}
-              {next ? (
-                <Link
-                  to={next.id}
-                  className="flex flex-col items-stretch gap-2 flex-1 min-w-max border rounded px-6 py-4 text-end hover:border-primary/85 transition shadow-sm hover:shadow-md"
-                  title={next.label}
-                >
-                  <div className="text-sm text-muted-foreground">
-                    Next page →
+        <div className="h-16" />
+        {(showLastModified && lastModifiedDate) || editUrl ? (
+          <div className="flex justify-between text-xs text-muted-foreground ">
+            <div />
+            <div className="flex items-center gap-2">
+              <div>
+                {editUrl && (
+                  <Button asChild variant="ghost" size="sm">
+                    <a
+                      href={editUrl}
+                      target="_blank"
+                      rel="noopener noreferrer"
+                      className="flex items-center gap-1"
+                    >
+                      <EditIcon size={12} />
+                      {editText}
+                    </a>
+                  </Button>
+                )}
+              </div>
+              <div>
+                {showLastModified && lastModifiedDate && (
+                  <div
+                    title={lastModifiedDate.toLocaleString(undefined, {
+                      dateStyle: "full",
+                      timeStyle: "medium",
+                    })}
+                  >
+                    Last modified on{" "}
+                    <time dateTime={lastModifiedDate.toISOString()}>
+                      {lastModifiedDate.toLocaleDateString(undefined, {
+                        dateStyle: "long",
+                      })}
+                    </time>
                   </div>
-                  <div className="text-lg text-primary truncate">
-                    {next.label}
-                  </div>
-                </Link>
-              ) : (
-                <div className="flex-1" />
-              )}
+                )}
+              </div>
             </div>
+          </div>
+        ) : null}
+        {!hidePager && (
+          <>
+            <div className="h-px bg-border mt-2 mb-6" />
+            <Pagination
+              prev={prev ? { to: prev.id, label: prev.label } : undefined}
+              next={next ? { to: next.id, label: next.label } : undefined}
+              className="mb-10"
+            />
           </>
         )}
-      </div>
-      <div className="hidden xl:block">
+      </Typography>
+      <div className="hidden xl:block" data-pagefind-ignore="all">
         {showToc && <Toc entries={tocEntries} />}
       </div>
     </div>

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

@@ -1,16 +1,15 @@
 import type { Toc } from "@stefanprobst/rehype-extract-toc";
 import type { MDXProps } from "mdx/types.js";
-import { RouteObject } from "react-router-dom";
-import { ZudokuDocsConfig } from "../../../config/validators/validate.js";
-import type { DevPortalPlugin } from "../../core/plugins.js";
-import { DocResolver } from "./resolver.js";
+import { type JSX } from "react";
+import type { ZudokuDocsConfig } from "../../../config/validators/validate.js";
+import type { ZudokuPlugin } from "../../core/plugins.js";
 
 export interface MarkdownPluginOptions extends ZudokuDocsConfig {
   fileImports: Record<string, () => Promise<MDXImport>>;
 }
 export type MarkdownPluginDefaultOptions = Pick<
   Frontmatter,
-  "toc" | "disablePager"
+  "toc" | "disablePager" | "showLastModified" | "suggestEdit"
 >;
 
 export type Frontmatter = {
@@ -19,55 +18,46 @@ export type Frontmatter = {
   category?: string;
   toc?: boolean;
   disablePager?: boolean;
+  disable_pager?: boolean;
+  showLastModified?: boolean;
+  lastModifiedTime?: number;
+  suggestEdit?:
+    | {
+        url: string;
+        text?: string;
+      }
+    | false;
 };
 
 export type MDXImport = {
   tableOfContents: Toc;
   frontmatter: Frontmatter;
+  excerpt?: string;
+  __filepath: string;
   default: (props: MDXProps) => JSX.Element;
 };
 
 export const markdownPlugin = (
-  options: MarkdownPluginOptions[],
-): DevPortalPlugin => ({
+  options: MarkdownPluginOptions,
+): ZudokuPlugin => ({
   getRoutes: () => {
-    const routeMap = new Map<string, RouteObject>();
-    options.forEach(({ fileImports, files, defaultOptions }) =>
-      Object.entries(fileImports).flatMap(([file, importPromise]) => {
-        const routePath = DocResolver.resolveRoutePath({
-          filesGlob: files,
-          fsPath: file,
-        });
-
-        if (!routePath) return [];
-
-        if (routeMap.has(routePath)) {
-          // eslint-disable-next-line no-console
-          console.warn(
-            `Duplicate route path found for ${routePath}. Skipping file at '${file}'.`,
-          );
-          return [];
-        }
-
-        const route: RouteObject = {
-          path: routePath,
-          lazy: async () => {
-            const { MdxPage } = await import("./MdxPage.js");
-            const { default: Component, ...props } = await importPromise();
-            return {
-              element: (
-                <MdxPage
-                  mdxComponent={Component}
-                  {...props}
-                  defaultOptions={defaultOptions}
-                />
-              ),
-            };
-          },
-        };
-        routeMap.set(routePath, route);
+    return Object.entries(options.fileImports).map(
+      ([routePath, importPromise]) => ({
+        path: routePath,
+        lazy: async () => {
+          const { MdxPage } = await import("./MdxPage.js");
+          const { default: Component, ...props } = await importPromise();
+          return {
+            element: (
+              <MdxPage
+                mdxComponent={Component}
+                {...props}
+                defaultOptions={options.defaultOptions}
+              />
+            ),
+          };
+        },
       }),
     );
-    return [...routeMap.values()];
   },
 });