zudoku 0.0.0-fd8f8ad → 0.0.0-feat-bundled-types.1c7f1db

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

@@ -1,25 +1,28 @@
-import { type RouteObject } from "react-router-dom";
-import { ZudokuContext } from "../../core/ZudokuContext.js";
+import { KeyRoundIcon } from "lucide-react";
+import { type RouteObject } from "react-router";
+import { type ZudokuContext } from "../../core/ZudokuContext.js";
 import {
   type ApiIdentityPlugin,
+  type ProfileMenuPlugin,
   type ZudokuPlugin,
-  ProfileMenuPlugin,
 } 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: ZudokuContext) => Promise<ApiKey[]>;
-  rollKey?: (id: string, context: ZudokuContext) => Promise<void>;
-  deleteKey?: (id: string, context: ZudokuContext) => Promise<void>;
-  updateKeyDescription?: (
-    apiKey: { id: string; description: string },
+  getConsumers: (context: ZudokuContext) => Promise<ApiConsumer[]>;
+  rollKey?: (consumerId: string, context: ZudokuContext) => Promise<void>;
+  deleteKey?: (
+    consumerId: string,
+    keyId: string,
+    context: ZudokuContext,
+  ) => Promise<void>;
+  updateConsumer?: (
+    consumer: { id: string; label?: string },
     context: ZudokuContext,
   ) => Promise<void>;
   getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
@@ -29,9 +32,9 @@ export type ApiKeyService = {
   ) => 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,138 @@ 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;
+}
 
+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);
       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");
+      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({
+                expiresOn: new Date(),
+              }),
+            },
+          ),
+        ),
+      );
+      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);
       invariant(keys.ok, "Failed to fetch API keys");
 
-      return await keys.json();
+      const data = (await keys.json()) as {
+        data: [
+          {
+            id: string;
+            label: string;
+            apiKeys: {
+              data: ApiKey[];
+            };
+          },
+        ];
+      };
+
+      return data.data.map((consumer) => ({
+        id: consumer.id,
+        label: consumer.label || "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,
 ): ZudokuPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
-  const endpoint =
-    "endpoint" in options ? options.endpoint : DEFAULT_API_KEY_ENDPOINT;
-
-  const service =
-    "getKeys" in options ? options : createDefaultHandler(endpoint);
+  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.description ?? consumer.id,
         }));
       } catch {
         return [];
@@ -134,10 +193,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,7 +1,7 @@
 import { type ComponentType, type ReactNode } from "react";
-import type { RouteObject } from "react-router-dom";
-import { type ExposedComponentProps } from "../../components/SlotletProvider.js";
+import type { RouteObject } from "react-router";
 import type { NavigationPlugin, ZudokuPlugin } from "../../core/plugins.js";
+import type { ExposedComponentProps } from "../../util/useExposedProps.js";
 import { CustomPage } from "./CustomPage.js";
 
 export type CustomPageConfig = {

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

@@ -1,19 +1,27 @@
 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 { type PropsWithChildren, useEffect } from "react";
 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 { 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 }) => (
@@ -30,16 +38,20 @@ const MarkdownHeadings = {
 
 export const MdxPage = ({
   mdxComponent: MdxComponent,
+  file,
   frontmatter = {},
   defaultOptions,
   tableOfContents,
+  excerpt,
 }: PropsWithChildren<
   Omit<MDXImport, "default"> & {
+    file: string;
     mdxComponent: MDXImport["default"];
     defaultOptions?: MarkdownPluginDefaultOptions;
   }
 >) => {
   const categoryTitle = useCurrentItem()?.categoryLabel;
+
   const title = frontmatter.title;
   const category = frontmatter.category ?? categoryTitle;
   const hideToc = frontmatter.toc === false || defaultOptions?.toc === false;
@@ -57,15 +69,34 @@ export const MdxPage = ({
 
   const { prev, next } = usePrevNext();
 
+  useEffect(() => {
+    if (process.env.NODE_ENV === "development") {
+      window.__getReactRefreshIgnoredExports = ({ id }) => {
+        if (!id.endsWith(file)) return;
+
+        return ["frontmatter", "tableOfContents"];
+      };
+
+      return () => {
+        window.__getReactRefreshIgnoredExports = undefined;
+      };
+    }
+  }, [file]);
+
   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>
+        {excerpt && <meta name="description" content={excerpt} />}
       </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]",
+          "max-w-full xl:w-full xl:max-w-3xl flex-1 shrink pt-(--padding-content-top)",
         )}
       >
         {(category || title) && (
@@ -83,41 +114,12 @@ export const MdxPage = ({
         />
         {!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>
-                  <div className="text-lg text-primary truncate">
-                    {next.label}
-                  </div>
-                </Link>
-              ) : (
-                <div className="flex-1" />
-              )}
-            </div>
+            <hr className="my-10" />
+            <Pagination
+              prev={prev ? { to: prev.id, label: prev.label } : undefined}
+              next={next ? { to: next.id, label: next.label } : undefined}
+              className="mb-4"
+            />
           </>
         )}
       </div>

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

@@ -1,7 +1,8 @@
 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 JSX } from "react";
+import type { RouteObject } from "react-router";
+import type { ZudokuDocsConfig } from "../../../config/validators/validate.js";
 import type { ZudokuPlugin } from "../../core/plugins.js";
 import { DocResolver } from "./resolver.js";
 
@@ -24,6 +25,7 @@ export type Frontmatter = {
 export type MDXImport = {
   tableOfContents: Toc;
   frontmatter: Frontmatter;
+  excerpt?: string;
   default: (props: MDXProps) => JSX.Element;
 };
 
@@ -57,6 +59,7 @@ export const markdownPlugin = (
             return {
               element: (
                 <MdxPage
+                  file={file}
                   mdxComponent={Component}
                   {...props}
                   defaultOptions={defaultOptions}

package/src/lib/plugins/markdown/resolver.ts

@@ -1,15 +1,10 @@
-import fs from "fs";
-import path from "path";
-import {
+import type {
   ZudokuConfig,
   ZudokuDocsConfig,
 } from "../../../config/validators/validate.js";
 
 const DEFAULT_DOCS_FILES = "/pages/**/*.{md,mdx}";
 
-// TODO: This should be dynamic based on the glob selector
-const SUPPORTED_EXTENSIONS = [".md", ".mdx"];
-
 /**
  * Utilities for resolving markdown file paths and routes
  */
@@ -31,34 +26,6 @@ export class DocResolver {
     return docsConfigs;
   }
 
-  /**
-   * Resolves the first matching file system path for a given docId
-   * @param docId - The docId to resolve
-   * @returns
-   */
-  resolveFilePath(docId: string) {
-    const docsConfigs = this.getDocsConfigs();
-    let fsPath: string | undefined;
-
-    docsConfigs.forEach(({ files: fileGlob }) => {
-      if (fsPath) {
-        return;
-      }
-      const rootDir = DocResolver.getRootDir(fileGlob);
-      for (const ext of SUPPORTED_EXTENSIONS) {
-        if (fsPath) {
-          return;
-        }
-        const checkPath = path.join(rootDir, `${docId}${ext}`);
-        if (fs.existsSync(checkPath)) {
-          fsPath = checkPath;
-        }
-      }
-    });
-
-    return fsPath;
-  }
-
   /**
    * Gets the root directory from a files glob
    */

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

@@ -1,3 +1,4 @@
+import { FoldVerticalIcon, UnfoldVerticalIcon } from "lucide-react";
 import { type CSSProperties, type ReactNode, useRef, useState } from "react";
 import { Button } from "zudoku/ui/Button.js";
 import {
@@ -43,22 +44,23 @@ export const CollapsibleCode = ({
       <CollapsibleContent
         forceMount
         className={cn(
-          "relative overflow-hidden",
-          !open && isOverflowing && "max-h-[--max-height]",
+          "relative overflow-hidden group",
+          !open && isOverflowing && "max-h-(--max-height)",
         )}
       >
         {!open && isOverflowing && (
-          <div className="absolute inset-0 bg-gradient-to-b from-transparent to-zinc-50/90 dark:to-zinc-800/90 z-10"></div>
+          <div className=" absolute inset-0 bg-gradient-to-b from-transparent to-zinc-50/60 dark:to-zinc-950/90 z-10 transition-all group-hover:to-transparent"></div>
         )}
         <div ref={contentRef}>{children}</div>
         {!open && isOverflowing && (
           <CollapsibleTrigger
-            className="absolute inset-0 grid place-items-center z-10"
+            className="absolute inset-0 grid place-items-center z-10 cursor-pointer peer"
             asChild
           >
             <div>
-              <Button className="bg-primary/70 border border-accent-foreground/25">
-                Expand code
+              <Button variant="outline" className="hidden group-hover:flex">
+                <UnfoldVerticalIcon size={14} className="me-1.5" />
+                Click to expand
               </Button>
             </div>
           </CollapsibleTrigger>
@@ -66,11 +68,15 @@ export const CollapsibleCode = ({
       </CollapsibleContent>
       {isOverflowing && (
         <div
-          className={cn("flex justify-center w-full mb-2", !open && "hidden")}
+          className={cn(
+            "flex justify-center w-full py-2 bg-muted/50",
+            !open && "hidden",
+          )}
         >
           <CollapsibleTrigger asChild>
-            <Button className="border border-accent-foreground/25">
-              Collapse code
+            <Button variant="outline" size="sm">
+              Collapse
+              <FoldVerticalIcon size={14} className="ms-1.5" />
             </Button>
           </CollapsibleTrigger>
         </div>

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

@@ -6,19 +6,30 @@ import { pastellize } from "../../util/pastellize.js";
 export const DATA_ATTR = "data-linked-param";
 
 export const usePastellizedColor = (name: string) => {
-  const { theme } = useTheme();
-  return pastellize(
-    name,
-    theme === "light" ? { saturation: 85, lightness: 50 } : undefined,
-  );
+  const { resolvedTheme } = useTheme();
+
+  return {
+    text: pastellize(
+      name,
+      resolvedTheme === "light" ? { saturation: 95, lightness: 38 } : {},
+    ),
+    background: pastellize(
+      name,
+      resolvedTheme === "light" ? { saturation: 85, lightness: 40 } : {},
+    ),
+  };
+};
+
+export const useParamColor = (name: string) => {
+  const normalized = name.replace(/[{}]/g, "");
+  return usePastellizedColor(normalized);
 };
 
 export const ColorizedParam = ({
   name,
   className,
-  backgroundOpacity = "100%",
-  borderOpacity = "100%",
   slug,
+  title,
   children,
   onClick,
 }: {
@@ -28,15 +39,17 @@ export const ColorizedParam = ({
   borderOpacity?: string;
   slug?: string;
   children?: ReactNode;
+  title?: string;
   onClick?: () => void;
 }) => {
   const ref = useRef<HTMLSpanElement>(null);
-  const normalized = name.replace(/[{}]/g, "");
   const normalizedSlug = slug?.replace(/[{}]/g, "");
-  const color = usePastellizedColor(normalized);
+  const normalized = name.replace(/[{}]/g, "");
+  const { text, background } = usePastellizedColor(normalized);
 
-  const borderColor = `hsl(${color} / ${borderOpacity})`;
-  const backgroundColor = `hsl(${color} / ${backgroundOpacity})`;
+  const textColor = `hsl(${text} / 100%)`;
+  const backgroundColor = `hsl(${background} / 10%)`;
+  const borderColor = `hsl(${background} / 50%)`;
 
   useEffect(() => {
     if (!normalizedSlug) return;
@@ -76,15 +89,19 @@ export const ColorizedParam = ({
     <span
       {...{ [DATA_ATTR]: normalizedSlug }}
       className={cn(
-        "relative after:rounded after:absolute after:inset-0 after:-bottom-0.5 after:border-b-2 after:transition-opacity after:duration-200",
-        "after:pointer-events-none after:border-[--border-color] after:opacity-30 after:data-[active=true]:opacity-100",
+        // This may not contain (inline-)flex or (inline-)block otherwise it breaks the browser's full text search
+        "relative transition-all duration-100 rounded-lg",
+        "border border-(--border-color) p-0.5 text-(--param-color) bg-(--background-color)",
+        "data-[active=true]:border-(--param-color) data-[active=true]:shadow-sm data-[active=true]:bottom-px",
         className,
       )}
+      title={title}
       suppressHydrationWarning
       ref={ref}
       onClick={onClick}
       style={
         {
+          "--param-color": textColor,
           "--border-color": borderColor,
           "--background-color": backgroundColor,
         } as CSSProperties