zudoku 0.1.1-dev.9 → 0.3.0-dev.11

package/src/{app → lib}/core/plugins.ts

@@ -1,18 +1,19 @@
+import { type ReactElement } from "react";
 import { type RouteObject } from "react-router-dom";
 import {
   DevPortalContext,
   type ApiIdentity,
   type NavigationCategory,
 } from "./DevPortalContext.js";
-import { type Combine } from "./types/combine.js";
 
 export type PluginNavigationCategory = {
   path: string;
 } & NavigationCategory;
 
-export type DevPortalPlugin = Combine<
-  [NavigationPlugin, ApiIdentityPlugin, InitializationPlugin]
->;
+export type DevPortalPlugin =
+  | CommonPlugin
+  | NavigationPlugin
+  | ApiIdentityPlugin;
 
 export interface NavigationPlugin {
   getRoutes: () => RouteObject[];
@@ -23,8 +24,9 @@ export interface ApiIdentityPlugin {
   getIdentities: (context: DevPortalContext) => Promise<ApiIdentity[]>;
 }
 
-export interface InitializationPlugin {
-  initialize: (context: DevPortalContext) => Promise<void> | void;
+export interface CommonPlugin {
+  initialize?: (context: DevPortalContext) => Promise<void> | void;
+  getHead?: () => ReactElement | undefined;
 }
 
 export const isNavigationPlugin = (
@@ -34,10 +36,13 @@ export const isNavigationPlugin = (
 
 export const needsInitialization = (
   obj: DevPortalPlugin,
-): obj is InitializationPlugin =>
+): obj is CommonPlugin =>
   "initialize" in obj && typeof obj.initialize === "function";
 
-export const isApiKeyPlugin = (
+export const hasHead = (obj: DevPortalPlugin): obj is CommonPlugin =>
+  "getHead" in obj && typeof obj.getHead === "function";
+
+export const isApiIdentityPlugin = (
   obj: DevPortalPlugin,
 ): obj is ApiIdentityPlugin =>
   "getIdentities" in obj && typeof obj.getIdentities === "function";

package/src/{app → lib}/oas/graphql/index.ts

@@ -45,7 +45,7 @@ export const slugifyOperation = (operation: OperationLike, tag?: string) => {
   );
 };
 
-const cache = new LRUCache<string, OpenAPIDocument>({
+const cache = new LRUCache<string, Promise<OpenAPIDocument>>({
   ttl: 60 * 10 * 1000,
   ttlAutopurge: true,
 });
@@ -69,7 +69,7 @@ const getAllOperations = (paths?: PathsObject, tag?: string) => {
       if (!value?.[method]) return [];
 
       const operation = value[method] as OperationObject;
-      const pathParameters = value?.parameters ?? [];
+      const pathParameters = value.parameters ?? [];
       const operationParameters = operation.parameters ?? [];
 
       // parameters are inherited from the parent path object,
@@ -189,7 +189,7 @@ const ParameterItem = builder
         resolve: (parent) =>
           Object.entries(parent.examples ?? {}).map(([name, value]) => ({
             name,
-            ...value,
+            ...(typeof value === "string" ? { value } : value),
           })),
         nullable: true,
       }),
@@ -384,7 +384,7 @@ const loadOpenAPISchema = async (input: NonNullable<unknown>) => {
     return cache.get(hash)!;
   }
 
-  const schema = await validate(input);
+  const schema = validate(input);
 
   cache.set(hash, schema);
 

package/src/{app → lib}/oas/parser/index.ts

@@ -54,7 +54,9 @@ const parseSchemaInput = async (
       return JSON.parse(schemaInput);
     }
     if (schemaInput.includes("://")) {
-      const response = await fetch(schemaInput);
+      const response = await fetch(schemaInput, {
+        cache: "force-cache",
+      });
       return (await response.json()) as JSONSchema;
     }
     const yaml = await import("yaml");

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

@@ -0,0 +1,94 @@
+import { useMutation } from "@tanstack/react-query";
+import { useForm } from "react-hook-form";
+import { Link, useNavigate } from "react-router-dom";
+import { useDevPortal } from "../../components/context/DevPortalProvider.js";
+import { Input } from "../../components/Input.js";
+import {
+  Select,
+  SelectContent,
+  SelectGroup,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "../../components/Select.js";
+import { Button } from "../../ui/Button.js";
+import { ApiKeyService } from "./index.js";
+
+type CreateApiKey = { description: string; expiresOn?: string };
+
+export const CreateApiKey = ({ service }: { service: ApiKeyService }) => {
+  const context = useDevPortal();
+  const navigate = useNavigate();
+  const form = useForm<CreateApiKey>({
+    defaultValues: {
+      expiresOn: "30",
+    },
+  });
+  const createKeyMutation = useMutation({
+    mutationFn: ({ description, expiresOn }: CreateApiKey) => {
+      if (!service.createKey) {
+        throw new Error("deleteKey not implemented");
+      }
+
+      const expiresOnDate =
+        expiresOn !== "never" ? addDaysToDate(Number(expiresOn)) : undefined;
+
+      return service.createKey(
+        { description: description, expiresOn: expiresOnDate },
+        context,
+      );
+    },
+    onSuccess: () => navigate("/settings/api-keys/"),
+  });
+
+  if (!service.createKey) {
+    return null;
+  }
+
+  return (
+    <div className="max-w-screen-lg pt-[--padding-content-top] pb-[--padding-content-bottom]">
+      <div className="flex justify-between mb-4 border-b border-border pb-1">
+        <h1 className="font-medium text-2xl">New API Key</h1>
+      </div>
+      <form
+        onSubmit={form.handleSubmit((data) => createKeyMutation.mutate(data))}
+      >
+        <div className="flex gap-2 flex-col">
+          Note
+          <Input {...form.register("description")} />
+          Expiration
+          <Select
+            onValueChange={(value) => form.setValue("expiresOn", value)}
+            defaultValue={form.getValues("expiresOn")}
+          >
+            <SelectTrigger>
+              <SelectValue />
+            </SelectTrigger>
+            <SelectContent>
+              <SelectGroup>
+                {[7, 30, 60, 90].map((option) => (
+                  <SelectItem value={String(option)} key={option}>
+                    {option} days
+                  </SelectItem>
+                ))}
+                <SelectItem value="never">Never</SelectItem>
+              </SelectGroup>
+            </SelectContent>
+          </Select>
+          <div className="flex gap-2">
+            <Button>Generate Key</Button>
+            <Button variant="outline" asChild>
+              <Link to="/settings/api-keys/">Cancel</Link>
+            </Button>
+          </div>
+        </div>
+      </form>
+    </div>
+  );
+};
+
+const addDaysToDate = (days: number): string => {
+  const date = new Date();
+  date.setDate(date.getDate() + days);
+  return date.toISOString();
+};

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

@@ -0,0 +1,132 @@
+import {
+  useMutation,
+  useQueryClient,
+  useSuspenseQuery,
+} from "@tanstack/react-query";
+import { EyeIcon, EyeOffIcon, RotateCwIcon, TrashIcon } from "lucide-react";
+import { useState } from "react";
+import { Link } from "react-router-dom";
+import { useDevPortal } from "../../components/context/DevPortalProvider.js";
+import { Button } from "../../ui/Button.js";
+import { ApiKeyService } from "./index.js";
+
+export const SettingsApiKeys = ({ service }: { service: ApiKeyService }) => {
+  const context = useDevPortal();
+  const queryClient = useQueryClient();
+  const { data } = useSuspenseQuery({
+    queryFn: () => service.getKeys(context),
+    queryKey: ["api-keys"],
+    retry: false,
+  });
+
+  const deleteKeyMutation = useMutation({
+    mutationFn: (id: string) => {
+      if (!service.deleteKey) {
+        throw new Error("deleteKey not implemented");
+      }
+
+      return service.deleteKey(id, context);
+    },
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: ["api-keys"] });
+    },
+  });
+
+  return (
+    <div className="max-w-screen-lg h-full pt-[--padding-content-top] pb-[--padding-content-bottom]">
+      <div className="flex justify-between mb-4 border-b border-border pb-3">
+        <h1 className="font-medium text-2xl">API Keys</h1>
+        {service.createKey && (
+          <Button asChild>
+            <Link to="/settings/api-keys/new">Create API Key</Link>
+          </Button>
+        )}
+      </div>
+
+      {data.length === 0 ? (
+        <div className="flex flex-col justify-center gap-4 items-center h-1/2 my-8">
+          <div className="text-center">
+            No API keys created yet.
+            <br />
+            Get started and create the first one now
+          </div>
+          {service.createKey && (
+            <Button asChild>
+              <Link to="/settings/api-keys/new">Create API Key</Link>
+            </Button>
+          )}
+        </div>
+      ) : (
+        <ul className="grid grid-cols-[minmax(250px,min-content)_1fr_min-content] ">
+          {data.map((key: any) => (
+            <li
+              className="border-b border-border p-5 grid grid-cols-subgrid col-span-full gap-2 items-center"
+              key={key.id}
+            >
+              <div className="flex flex-col gap-1 text-sm">
+                {key.description ?? key.id}
+                <div className="text-muted-foreground text-xs">
+                  {key.createdOn && (
+                    <div>
+                      Created on {new Date(key.createdOn).toLocaleDateString()}
+                    </div>
+                  )}
+                  {key.expiresOn && (
+                    <div>
+                      Expires on {new Date(key.expiresOn).toLocaleDateString()}
+                    </div>
+                  )}
+                </div>
+              </div>
+              <div className="items-center flex justify-center">
+                <RevealApiKey apiKey={key.key} />
+              </div>
+              <div className="flex gap-2">
+                {service.rollKey && (
+                  <Button size="icon">
+                    <RotateCwIcon size={16} />
+                  </Button>
+                )}
+                {service.deleteKey && (
+                  <Button
+                    variant="ghost"
+                    size="icon"
+                    onClick={() => {
+                      if (!confirm("Do you want to delete this key?")) {
+                        return;
+                      }
+
+                      deleteKeyMutation.mutate(key.id);
+                    }}
+                    disabled={deleteKeyMutation.isPending}
+                  >
+                    <TrashIcon size={16} />
+                  </Button>
+                )}
+              </div>
+            </li>
+          ))}
+        </ul>
+      )}
+    </div>
+  );
+};
+
+const RevealApiKey = ({ apiKey }: { apiKey: string }) => {
+  const [revealed, setRevealed] = useState(false);
+
+  return (
+    <div className="flex gap-2 items-center text-sm">
+      <code className="border border-border rounded bg-gray-100 dark:bg-gray-950 p-1 font-mono">
+        {revealed ? apiKey : "•".repeat(apiKey.length)}
+      </code>
+      <Button
+        variant="outline"
+        onClick={() => setRevealed((prev) => !prev)}
+        size="icon"
+      >
+        {revealed ? <EyeOffIcon size={16} /> : <EyeIcon size={16} />}
+      </Button>
+    </div>
+  );
+};

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

@@ -0,0 +1,160 @@
+import logger from "loglevel";
+import { Outlet, useRouteError } from "react-router-dom";
+import invariant from "tiny-invariant";
+import { useAuth } from "../../authentication/hook.js";
+import { DevPortalContext } from "../../core/DevPortalContext.js";
+import {
+  type ApiIdentityPlugin,
+  type DevPortalPlugin,
+} from "../../core/plugins.js";
+import { Button } from "../../ui/Button.js";
+import { CreateApiKey } from "./CreateApiKey.js";
+import { SettingsApiKeys } from "./SettingsApiKeys.js";
+
+export type ApiKeyResults = Promise<ApiKey[]>;
+const DEFAULT_API_KEY_ENDPOINT =
+  "https://zudoku-rewiringamerica-main-ef9c9c0.d2.zuplo.dev";
+
+export type ApiKeyService = {
+  getKeys: (context: DevPortalContext) => ApiKeyResults;
+  rollKey?: (id: string, context: DevPortalContext) => Promise<void>;
+  deleteKey?: (id: string, context: DevPortalContext) => Promise<void>;
+  updateKeyDescription?: (
+    apiKey: { jd: string; description: string },
+    context: DevPortalContext,
+  ) => Promise<void>;
+  getUsage?: (apiKeys: string[], context: DevPortalContext) => Promise<void>;
+  createKey?: (
+    apiKey: { description: string; expiresOn?: string },
+    context: DevPortalContext,
+  ) => Promise<void>;
+};
+
+export type GetApiKeysOptions = ApiKeyService | { endpoint: string } | object;
+
+export type ApiKeyPluginOptions = object & GetApiKeysOptions;
+
+export interface ApiKey {
+  id: string;
+  description?: string;
+  createdOn?: string;
+  updatedOn?: string;
+  expiresOn?: string;
+  key: string;
+}
+
+const createDefaultHandler = (endpoint: string): ApiKeyService => {
+  return {
+    deleteKey: async (id, context) => {
+      const request = new Request(endpoint + `/v1/developer/api-keys/${id}`, {
+        method: "DELETE",
+      });
+
+      await context.signRequest(request);
+
+      const response = await fetch(request);
+      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`);
+
+      await context.signRequest(request);
+
+      const keys = await fetch(request);
+      invariant(keys.ok, "Failed to fetch API keys");
+
+      return await keys.json();
+    },
+  };
+};
+
+const ProtectedRoute = () => {
+  const auth = useAuth();
+
+  // TODO: should we suspend here somehow?
+  if (auth.isPending) {
+    return null;
+  }
+
+  return auth.isAuthenticated ? (
+    <Outlet />
+  ) : (
+    <div className="flex flex-col justify-center gap-2 items-center h-1/2 my-12">
+      Please login first to view this page
+      <Button onClick={() => auth.login()}>Login</Button>
+    </div>
+  );
+};
+
+const SettingsErrorBoundary = () => {
+  const error = useRouteError();
+  logger.error(String(error));
+
+  return (
+    <div className="flex flex-col justify-center gap-2 items-center h-1/2 my-12">
+      <h1>Something went wrong</h1>
+      {error instanceof Error && <p>{error.message}</p>}
+    </div>
+  );
+};
+
+export const apiKeyPlugin = (
+  options: ApiKeyPluginOptions,
+): DevPortalPlugin & ApiIdentityPlugin => {
+  const endpoint =
+    "endpoint" in options ? options.endpoint : DEFAULT_API_KEY_ENDPOINT;
+
+  const service =
+    "getKeys" in options ? options : createDefaultHandler(endpoint);
+
+  return {
+    getIdentities: async (context) => {
+      try {
+        const keys = await service.getKeys(context);
+
+        return keys.map((key) => ({
+          authorizeRequest: (request) => {
+            request.headers.set("Authorization", `Bearer ${key.key}`);
+            return request;
+          },
+          id: key.id,
+          label: key.description ?? key.id,
+        }));
+      } catch {
+        return [];
+      }
+    },
+    getRoutes: () => {
+      return [
+        {
+          element: <ProtectedRoute />,
+          errorElement: <SettingsErrorBoundary />,
+          children: [
+            {
+              path: "/settings/api-keys",
+              element: <SettingsApiKeys service={service} />,
+            },
+            {
+              path: "/settings/api-keys/new",
+              element: <CreateApiKey service={service} />,
+            },
+          ],
+        },
+      ];
+    },
+  };
+};

package/src/lib/plugins/index.ts

@@ -0,0 +1,4 @@
+export { apiKeyPlugin } from "./api-key/index.js";
+export { markdownPlugin } from "./markdown/index.js";
+export { openApiPlugin } from "./openapi/index.js";
+export { redirectPlugin } from "./redirect/index.js";

package/src/{app → lib}/plugins/markdown/MdxPage.tsx

@@ -1,22 +1,42 @@
+import { useMDXComponents } from "@mdx-js/react";
 import { useMemo, type PropsWithChildren, type ReactNode } from "react";
-import { Heading } from "../../Heading.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { Heading } from "../../components/Heading.js";
 import { ProseClasses } from "../../components/Markdown.js";
 import { useTopNavigationItem } from "../../components/context/DevPortalProvider.js";
 import { isPathItem } from "../../components/navigation/util.js";
 import { Helmet } from "../../core/helmet.js";
 import { Link, useLocation } from "../../core/router.js";
+import type { MdxComponentsType } from "../../util/MdxComponents.js";
 import { cn } from "../../util/cn.js";
 import slugify from "../../util/slugify.js";
 import { traverseNavigation } from "../../util/traverseNavigation.js";
 import { Toc } from "./Toc.js";
 import type { MDXImport } from "./index.js";
 
+const MarkdownHeadings = {
+  h2: ({ children, id }) => (
+    <Heading level={2} id={id} registerSidebarAnchor>
+      {children}
+    </Heading>
+  ),
+  h3: ({ children, id }) => (
+    <Heading level={3} id={id} registerSidebarAnchor>
+      {" "}
+      {children}
+    </Heading>
+  ),
+} satisfies MdxComponentsType;
+
 export const MdxPage = ({
-  children,
-  frontmatter,
+  mdxComponent: MdxComponent,
+  frontmatter = {},
   tableOfContents,
-}: PropsWithChildren<Omit<MDXImport, "default">>) => {
+}: PropsWithChildren<
+  Omit<MDXImport, "default"> & {
+    mdxComponent: MDXImport["default"];
+  }
+>) => {
   const navItem = useTopNavigationItem();
   const location = useLocation();
 
@@ -28,9 +48,9 @@ export const MdxPage = ({
       })
     : undefined;
 
-  const title = frontmatter?.title;
-  const category = frontmatter?.category ?? categoryTitle;
-  const hideToc = frontmatter?.toc === false;
+  const title = frontmatter.title;
+  const category = frontmatter.category ?? categoryTitle;
+  const hideToc = frontmatter.toc === false;
 
   const pageTitle =
     tableOfContents.find((item) => item.depth === 1)?.value ?? title;
@@ -75,21 +95,23 @@ export const MdxPage = ({
       <div
         className={cn(
           ProseClasses,
-          "mx-auto 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-prose flex-1 flex-shrink pt-[--padding-content-top] pb-[--padding-content-bottom]",
         )}
       >
-        <header className="-translate-y-1">
+        <header>
           {category && <CategoryHeading>{category}</CategoryHeading>}
           {title && (
             <Heading level={1} id={slugify(title, { lower: true })}>
               {title}
             </Heading>
           )}
-          {frontmatter?.description && (
+          {frontmatter.description && (
             <p className="prose-lg">{frontmatter.description}</p>
           )}
         </header>
-        {children}
+        <MdxComponent
+          components={{ ...useMDXComponents(), ...MarkdownHeadings }}
+        />
         <hr />
         <div className="not-prose flex items-center justify-between gap-8">
           {prev.path ? (

package/src/{app → lib}/plugins/markdown/generateRoutes.tsx

@@ -1,21 +1,10 @@
-import { Heading } from "../../Heading.js";
 import { useTopNavigationItem } from "../../components/context/DevPortalProvider.js";
 import { isPathItem } from "../../components/navigation/util.js";
 import { Navigate, type RouteObject } from "../../core/router.js";
-import type { MdxComponentsType } from "../../util/MdxComponents.js";
 import { traverseNavigation } from "../../util/traverseNavigation.js";
 import { MdxPage } from "./MdxPage.js";
 import type { MarkdownPluginOptions } from "./index.js";
 
-const MarkdownHeadings = {
-  h2: ({ children, id }) => (
-    <Heading level={2} id={id} children={children} registerSidebarAnchor />
-  ),
-  h3: ({ children, id }) => (
-    <Heading level={3} id={id} children={children} registerSidebarAnchor />
-  ),
-} satisfies MdxComponentsType;
-
 export const generateRoutes = (
   markdownFiles: MarkdownPluginOptions["markdownFiles"],
 ): RouteObject[] => {
@@ -39,11 +28,7 @@ export const generateRoutes = (
           const { default: Component, ...props } = await importPromise();
 
           return {
-            element: (
-              <MdxPage {...props}>
-                <Component components={MarkdownHeadings} />
-              </MdxPage>
-            ),
+            element: <MdxPage mdxComponent={Component} {...props} />,
           };
         },
       } satisfies RouteObject;

package/src/{app → lib}/plugins/openapi/ColorizedParam.tsx

@@ -15,7 +15,6 @@ export const usePastellizedColor = (name: string) => {
 
 export const ColorizedParam = ({
   name,
-  value,
   className,
   backgroundOpacity = "100%",
   slug,
@@ -23,7 +22,6 @@ export const ColorizedParam = ({
   onClick,
 }: {
   name: string;
-  value?: string;
   className?: string;
   backgroundOpacity?: string;
   slug?: string;
@@ -76,7 +74,7 @@ export const ColorizedParam = ({
         className="absolute inset-0 border-b-2 transition-opacity duration-200 opacity-30 group-data-[active=true]:opacity-100"
         style={{ borderColor, backgroundColor }}
       />
-      <span className="relative">{children || name}</span>
+      <span className="relative">{children ?? name}</span>
     </span>
   );
 };