zudoku 0.45.1 → 0.46.0

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

@@ -1,24 +1,26 @@
-import { FileKey2Icon } from "lucide-react";
+import { KeyRoundIcon } from "lucide-react";
 import { type RouteObject } from "react-router";
-import { ZudokuContext } from "../../core/ZudokuContext.js";
+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>;
+  getConsumers: (context: ZudokuContext) => Promise<ApiConsumer[]>;
+  rollKey?: (consumerId: string, context: ZudokuContext) => Promise<void>;
+  deleteKey?: (
+    consumerId: string,
+    keyId: string,
+    context: ZudokuContext,
+  ) => Promise<void>;
   updateKeyDescription?: (
     apiKey: { id: string; description: string },
     context: ZudokuContext,
@@ -30,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;
@@ -43,51 +45,79 @@ 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;
+  name: 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) => {
+    rollKey: async (consumerId, 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/${consumerId}/roll-key`,
+            {
+              method: "POST",
+              headers: {
+                "Content-Type": "application/json",
+              },
+              body: JSON.stringify({
+                expiresOn: new Date(),
+              }),
+            },
+          ),
         ),
       );
       invariant(response.ok, "Failed to delete API key");
     },
-    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");
-    },
-    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;
+            name: string;
+            apiKeys: {
+              data: ApiKey[];
+            };
+          },
+        ];
+      };
+
+      return data.data.map((consumer) => ({
+        id: consumer.id,
+        name: consumer.name,
+        apiKeys: consumer.apiKeys.data,
+        key: consumer.apiKeys.data.at(0),
+      }));
     },
   };
 };
@@ -98,11 +128,10 @@ export const createApiKeyService = <T extends ApiKeyService>(service: T): T =>
 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: () => [
@@ -110,20 +139,37 @@ export const apiKeyPlugin = (
         label: "API Keys",
         path: "/settings/api-keys",
         category: "middle",
-        icon: FileKey2Icon,
+        icon: KeyRoundIcon,
       },
     ],
+    getSidebar: async (path) => {
+      if (!path.startsWith("/settings")) {
+        return [];
+      }
+
+      return [
+        {
+          type: "link",
+          label: "API Keys",
+          icon: KeyRoundIcon,
+          href: "/settings/api-keys",
+        },
+      ];
+    },
     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 [];
@@ -140,10 +186,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";
-import { type ExposedComponentProps } from "../../components/SlotletProvider.js";
 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

@@ -85,7 +85,7 @@ export const MdxPage = ({
 
   return (
     <div
-      className="grid grid-cols-1 xl:grid-cols-[--sidecar-grid-cols] gap-8 justify-between"
+      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"
     >
@@ -96,7 +96,7 @@ export const MdxPage = ({
       <div
         className={cn(
           ProseClasses,
-          "max-w-full xl:w-full xl:max-w-3xl flex-1 flex-shrink pt-[--padding-content-top]",
+          "max-w-full xl:w-full xl:max-w-3xl flex-1 shrink pt-(--padding-content-top)",
         )}
       >
         {(category || title) && (

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

@@ -1,8 +1,8 @@
 import type { Toc } from "@stefanprobst/rehype-extract-toc";
 import type { MDXProps } from "mdx/types.js";
 import { type JSX } from "react";
-import { RouteObject } from "react-router";
-import { ZudokuDocsConfig } from "../../../config/validators/common.js";
+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";
 

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

@@ -1,5 +1,7 @@
-import { ZudokuDocsConfig } from "../../../config/validators/common.js";
-import { ZudokuConfig } from "../../../config/validators/validate.js";
+import type {
+  ZudokuConfig,
+  ZudokuDocsConfig,
+} from "../../../config/validators/validate.js";
 
 const DEFAULT_DOCS_FILES = "/pages/**/*.{md,mdx}";
 

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

@@ -45,7 +45,7 @@ export const CollapsibleCode = ({
         forceMount
         className={cn(
           "relative overflow-hidden group",
-          !open && isOverflowing && "max-h-[--max-height]",
+          !open && isOverflowing && "max-h-(--max-height)",
         )}
       >
         {!open && isOverflowing && (

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

@@ -91,8 +91,8 @@ export const ColorizedParam = ({
       className={cn(
         // 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 data-[active=true]:bottom-px",
+        "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}

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

@@ -223,7 +223,7 @@ export const OperationList = ({
 
   return (
     <div
-      className="pt-[--padding-content-top]"
+      className="pt-(--padding-content-top)"
       data-pagefind-filter="section:openapi"
       data-pagefind-meta="section:openapi"
     >
@@ -298,7 +298,7 @@ export const OperationList = ({
                 )}
               >
                 <Markdown
-                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  className="border rounded-sm bg-muted/25 border-border px-2.5 md:px-4"
                   content={schema.description}
                 />
               </div>

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

@@ -3,13 +3,13 @@ import { useState } from "react";
 import { Badge } from "zudoku/ui/Badge.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
-import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
 import { cn } from "../../util/cn.js";
 import { groupBy } from "../../util/groupBy.js";
 import { renderIf } from "../../util/renderIf.js";
 import { OperationsFragment } from "./OperationList.js";
 import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
+import { ResponseContent } from "./components/ResponseContent.js";
 import { SelectOnClick } from "./components/SelectOnClick.js";
 import { useOasConfig } from "./context.js";
 import { type FragmentType, useFragment } from "./graphql/index.js";
@@ -135,39 +135,11 @@ export const OperationListItem = ({
                 )}
                 Responses
               </Heading>
-              <Tabs
-                onValueChange={(value) => setSelectedResponse(value)}
-                value={selectedResponse}
-              >
-                {operation.responses.length > 1 && (
-                  <TabsList>
-                    {operation.responses.map((response) => (
-                      <TabsTrigger
-                        value={response.statusCode}
-                        key={response.statusCode}
-                        title={response.description ?? undefined}
-                      >
-                        {response.statusCode}
-                      </TabsTrigger>
-                    ))}
-                  </TabsList>
-                )}
-                <ul className="list-none m-0 px-0">
-                  {operation.responses.map((response) => (
-                    <TabsContent
-                      value={response.statusCode}
-                      key={response.statusCode}
-                    >
-                      <SchemaView
-                        schema={
-                          response.content?.find((content) => content.schema)
-                            ?.schema
-                        }
-                      />
-                    </TabsContent>
-                  ))}
-                </ul>
-              </Tabs>
+              <ResponseContent
+                responses={operation.responses}
+                selectedResponse={selectedResponse}
+                onSelectResponse={setSelectedResponse}
+              />
             </>
           )}
         </div>

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

@@ -29,6 +29,7 @@ export const PlaygroundDialogWrapper = ({
       enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
       type: p.schema?.type ?? "string",
     }));
+
   const queryParams = operation.parameters
     ?.filter((p) => p.in === "query")
     .sort((a, b) => (a.required && !b.required ? -1 : 1))
@@ -38,10 +39,15 @@ export const PlaygroundDialogWrapper = ({
       isRequired: p.required ?? false,
       enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
       type: p.schema?.type ?? "string",
+      defaultValue: p.schema?.default,
     }));
+
   const pathParams = operation.parameters
     ?.filter((p) => p.in === "path")
-    .map((p) => ({ name: p.name }));
+    .map((p) => ({
+      name: p.name,
+      defaultValue: p.schema?.default,
+    }));
 
   return (
     <PlaygroundDialog

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

@@ -1,28 +1,15 @@
 import * as Tabs from "@radix-ui/react-tabs";
 import { cn } from "../../util/cn.js";
-import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SidecarExamples } from "./SidecarExamples.js";
-
-type Responses = OperationListItemResult["responses"];
-
-const ResponseContent = ({ response }: { response: Responses[number] }) => {
-  return (
-    <Tabs.Content value={response.statusCode}>
-      <SidecarExamples
-        content={response.content ?? []}
-        description={response.description ?? undefined}
-      />
-    </Tabs.Content>
-  );
-};
+import type { ResponseItem } from "./graphql/graphql.js";
 
 export const ResponsesSidecarBox = ({
   responses,
   selectedResponse,
   onSelectResponse,
 }: {
-  responses: Responses;
+  responses: ResponseItem[];
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
@@ -52,7 +39,9 @@ export const ResponsesSidecarBox = ({
           </Tabs.List>
         </SidecarBox.Head>
         {responses.map((response) => (
-          <ResponseContent key={response.statusCode} response={response} />
+          <Tabs.Content key={response.statusCode} value={response.statusCode}>
+            <SidecarExamples content={response.content ?? []} />
+          </Tabs.Content>
         ))}
       </Tabs.Root>
     </SidecarBox.Root>

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

@@ -1,5 +1,6 @@
 import slugify from "@sindresorhus/slugify";
 import { useSuspenseQuery } from "@tanstack/react-query";
+import { Helmet } from "@zudoku/react-helmet-async";
 import {
   ChevronRightIcon,
   ChevronsDownUpIcon,
@@ -47,23 +48,34 @@ export function SchemaList() {
   const { data } = useSuspenseQuery(schemasQuery);
 
   const schemas = data.schema.components?.schemas ?? [];
-
-  if (!schemas.length) {
-    return <div>No schemas found</div>;
-  }
-
   const hasMultipleVersions = Object.entries(versions).length > 1;
   const showVersions =
     options?.showVersionSelect === "always" ||
     (hasMultipleVersions && options?.showVersionSelect !== "hide");
 
+  if (!schemas.length) {
+    return (
+      <div>
+        <Helmet>
+          <title>Schemas {showVersions ? version : ""}</title>
+          <meta name="description" content="List of schemas used by the API." />
+        </Helmet>
+        No schemas found
+      </div>
+    );
+  }
+
   return (
     <div
-      className="grid grid-cols-[--sidecar-grid-cols] gap-8 justify-between"
+      className="grid grid-cols-(--sidecar-grid-cols) gap-8 justify-between"
       data-pagefind-filter="section:openapi"
       data-pagefind-meta="section:openapi"
     >
-      <div className="pt-[--padding-content-top] pb-[--padding-content-bottom]">
+      <Helmet>
+        <title>Schemas {showVersions ? version : ""}</title>
+        <meta name="description" content="List of schemas used by the API." />
+      </Helmet>
+      <div className="pt-(--padding-content-top) pb-(--padding-content-bottom)">
         <Collapsible className="w-full">
           <div className="flex flex-col gap-y-4 sm:flex-row justify-around items-start sm:items-end">
             <div className="flex-1">
@@ -105,7 +117,7 @@ export function SchemaList() {
                 )}
               >
                 <Markdown
-                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  className="border rounded-sm bg-muted/25 border-border px-2.5 md:px-4"
                   content={data.schema.description}
                 />
               </div>

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

@@ -231,7 +231,7 @@ export const Sidecar = ({
   return (
     <aside
       ref={ref}
-      className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4"
+      className="flex flex-col overflow-hidden sticky top-(--scroll-padding) gap-4"
       data-pagefind-ignore="all"
     >
       <SidecarBox.Root>

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

@@ -22,7 +22,13 @@ const formatForDisplay = (value: unknown): string => {
 
 const getLanguage = (mediaType?: string): string => {
   if (!mediaType) return "plain";
+  if (mediaType.endsWith("+json")) return "json";
+  if (mediaType.endsWith("+xml")) return "xml";
+  if (mediaType.endsWith("+yaml")) return "yaml";
+
   const languages: Record<string, string> = {
+    "text/html": "html",
+    "application/x-ndjson": "json",
     "application/json": "json",
     "application/xml": "xml",
     "application/x-yaml": "yaml",

package/src/lib/plugins/openapi/components/EnumValues.tsx

@@ -26,7 +26,7 @@ export const EnumValues = ({
       <span className="text-muted-foreground">Enum values: </span>
       {visibleValues.map((value) => (
         <div key={value}>
-          <SelectOnClick className="border rounded px-1 font-mono">
+          <SelectOnClick className="border rounded-sm px-1 font-mono">
             {value}
           </SelectOnClick>
         </div>

package/src/lib/plugins/openapi/components/ResponseContent.tsx

@@ -0,0 +1,104 @@
+import * as Tabs from "@radix-ui/react-tabs";
+import { useState } from "react";
+import { Markdown } from "zudoku/components";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "zudoku/ui/Select.js";
+import { cn } from "zudoku/ui/util.js";
+import type { MediaTypeObject } from "../graphql/graphql.js";
+import { SchemaView } from "../schema/SchemaView.js";
+
+type Response = {
+  statusCode: string;
+  description?: string | null;
+  content?: MediaTypeObject[] | null;
+};
+
+export const ResponseContent = ({
+  responses,
+  selectedResponse,
+  onSelectResponse,
+}: {
+  responses: Response[];
+  selectedResponse?: string;
+  onSelectResponse?: (value: string) => void;
+}) => {
+  const [selectedMediaType, setSelectedMediaType] = useState(
+    responses[0]?.content?.[0]?.mediaType ?? "",
+  );
+  const currentResponse =
+    responses.find((r) => r.statusCode === selectedResponse) ?? responses[0];
+
+  const cardHeader = (
+    <div className="flex flex-col bg-muted text-muted-foreground">
+      <div className="flex flex-row items-center gap-2 justify-between px-4 py-2">
+        <Tabs.List className="flex flex-row font-medium text-sm gap-4">
+          {responses.map((response) => (
+            <Tabs.Trigger
+              key={response.statusCode}
+              value={response.statusCode}
+              className={cn(
+                "py-1 -mx-2 px-2 rounded-md",
+                "data-[state=active]:dark:ring-1 data-[state=active]:dark:ring-border data-[state=active]:bg-background data-[state=active]:drop-shadow",
+                "data-[state=active]:font-semibold data-[state=active]:text-foreground",
+              )}
+            >
+              {response.statusCode}
+            </Tabs.Trigger>
+          ))}
+        </Tabs.List>
+        {currentResponse?.content && currentResponse.content.length > 1 && (
+          <Select
+            value={selectedMediaType}
+            onValueChange={setSelectedMediaType}
+          >
+            <SelectTrigger className="h-8 mt-0 max-w-48 text-xs truncate">
+              <SelectValue placeholder="Select a type" />
+            </SelectTrigger>
+            <SelectContent>
+              {currentResponse.content.map((c) => (
+                <SelectItem key={c.mediaType} value={c.mediaType}>
+                  {c.mediaType}
+                </SelectItem>
+              ))}
+            </SelectContent>
+          </Select>
+        )}
+      </div>
+      {currentResponse?.description && (
+        <Markdown
+          className="text-sm border-t px-4 py-2 text-muted-foreground"
+          content={currentResponse.description}
+        />
+      )}
+    </div>
+  );
+
+  return (
+    <div className="flex flex-col gap-2">
+      <Tabs.Root
+        value={selectedResponse}
+        onValueChange={(value) => {
+          onSelectResponse?.(value);
+          const newResponse = responses.find((r) => r.statusCode === value);
+          setSelectedMediaType(newResponse?.content?.[0]?.mediaType ?? "");
+        }}
+      >
+        {responses.map((response) => {
+          const content = response.content?.find(
+            (c) => c.mediaType === selectedMediaType,
+          );
+          return (
+            <Tabs.Content key={response.statusCode} value={response.statusCode}>
+              <SchemaView schema={content?.schema} cardHeader={cardHeader} />
+            </Tabs.Content>
+          );
+        })}
+      </Tabs.Root>
+    </div>
+  );
+};