zudoku 0.1.1-dev.5 → 0.1.1-dev.51

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "zudoku",
-  "version": "0.1.1-dev.5",
+  "version": "0.1.1-dev.51",
   "type": "module",
   "files": [
     "dist",
-    "src/app",
-    "cli.js"
+    "lib",
+    "cli.js",
+    "src/lib",
+    "src/app"
   ],
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -16,11 +18,20 @@
     ".": {
       "import": "./dist/index.js"
     },
-    "./auth": {
-      "import": "./dist/auth.js"
+    "./auth/clerk": {
+      "import": "./lib/zudoku.auth-clerk.js"
+    },
+    "./auth/auth0": {
+      "import": "./lib/zudoku.auth-auth0.js"
     },
     "./plugins": {
-      "import": "./dist/plugins.js"
+      "import": "./lib/zudoku.plugins.js"
+    },
+    "./openapi-worker": {
+      "import": "./lib/zudoku.openapi-worker.js"
+    },
+    "./components": {
+      "import": "./lib/zudoku.components.js"
     },
     "./vite": {
       "require": "./dist/vite/plugin.js",
@@ -30,86 +41,79 @@
       "require": "./dist/app/tailwind.js",
       "import": "./dist/app/tailwind.js"
     },
-    "./icons": {
-      "require": "./dist/app/core/icons.js",
-      "import": "./dist/app/core/icons.js"
-    },
     "./main.css": {
       "require": "./src/app/main.css",
       "import": "./src/app/main.css"
+    },
+    "./app/*": {
+      "import": "./src/app/*"
     }
   },
   "dependencies": {
-    "@cfworker/json-schema": "1.12.8",
-    "@clerk/clerk-js": "^5.2.2",
-    "@graphql-typed-document-node/core": "^3.2.0",
+    "@graphql-typed-document-node/core": "3.2.0",
     "@lekoarts/rehype-meta-as-attributes": "3.0.1",
     "@mdx-js/react": "3.0.1",
     "@mdx-js/rollup": "3.0.1",
+    "@monaco-editor/react": "^4.6.0",
     "@pothos/core": "3.41.0",
-    "@radix-ui/react-collapsible": "1.0.3",
-    "@radix-ui/react-dialog": "^1.1.1",
-    "@radix-ui/react-slot": "^1.1.0",
-    "@radix-ui/react-tabs": "^1.1.0",
-    "@sentry/node": "^8.11.0",
+    "@radix-ui/react-select": "2.1.1",
+    "@radix-ui/react-visually-hidden": "1.1.0",
+    "@sentry/node": "8.11.0",
     "@stefanprobst/rehype-extract-toc": "2.2.0",
     "@tailwindcss/typography": "0.5.13",
-    "@tanstack/react-query": "5.35.1",
-    "@vitejs/plugin-react": "4.3.0",
-    "@zudoku/httpsnippet": "10.0.9",
-    "@zuplo/pino-pretty-configurations": "^1.5.0",
+    "@vitejs/plugin-react": "4.3.1",
     "autoprefixer": "10.4.19",
-    "chalk": "^5.3.0",
-    "class-variance-authority": "0.7.0",
-    "clsx": "2.1.1",
-    "dotenv": "^16.4.5",
-    "esbuild": "^0.23.0",
-    "express": "^4.19.2",
-    "graphql": "^16.9.0",
+    "chokidar": "^3.6.0",
+    "dotenv": "16.4.5",
+    "esbuild": "0.23.0",
+    "express": "4.19.2",
+    "graphql": "16.9.0",
     "graphql-type-json": "0.3.2",
     "graphql-yoga": "5.2.0",
+    "loglevel": "^1.9.1",
     "lru-cache": "10.2.0",
-    "lucide-react": "0.378.0",
-    "mdx": "^0.3.1",
-    "oauth4webapi": "2.10.4",
+    "mdx": "0.3.1",
     "object-hash": "3.0.0",
     "openapi-types": "12.1.3",
-    "pino": "^9.2.0",
-    "postcss": "8.4.38",
+    "picocolors": "^1.0.1",
+    "postcss": "8.4.39",
     "posthog-node": "^4.0.1",
     "prism-react-renderer": "2.3.1",
     "prismjs": "1.29.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-helmet-async": "2.0.5",
+    "react-hook-form": "^7.52.1",
     "react-markdown": "9.0.1",
-    "react-router-dom": "6.23.0",
+    "react-router-dom": "6.24.1",
     "rehype-slug": "6.0.0",
     "remark-comment": "1.0.0",
     "remark-directive": "3.0.0",
     "remark-directive-rehype": "0.4.2",
     "remark-frontmatter": "5.0.0",
     "remark-gfm": "4.0.0",
-    "remark-mdx-frontmatter": "4.0.0",
-    "semver": "^7.6.2",
+    "remark-mdx-frontmatter": "5.0.0",
+    "semver": "7.6.2",
     "slugify": "1.6.6",
-    "strip-ansi": "^7.1.0",
-    "tailwind-merge": "2.3.0",
-    "tailwindcss": "3.4.3",
-    "ulid": "2.3.0",
+    "strip-ansi": "7.1.0",
+    "tailwindcss": "3.4.4",
+    "ulidx": "^2.3.0",
     "unist-util-visit": "5.0.0",
     "urql": "4.1.0",
-    "vite": "^5.3.1",
-    "vite-plugin-dts": "^3.9.1",
+    "vite": "5.3.3",
     "yaml": "2.4.1",
-    "yargs": "^17.7.2",
-    "zustand": "^4.5.2"
+    "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@graphql-codegen/cli": "^5.0.2",
+    "@radix-ui/react-collapsible": "1.1.0",
+    "@radix-ui/react-dialog": "1.1.1",
+    "@radix-ui/react-slot": "1.1.0",
+    "@radix-ui/react-tabs": "1.1.0",
+    "@tanstack/react-query": "5.50.1",
     "@types/express": "^4.17.21",
     "@types/har-format": "^1.2.15",
     "@types/json-schema": "7.0.15",
+    "@types/loglevel": "^1.6.3",
     "@types/mdx": "2.0.13",
     "@types/node": "20.12.10",
     "@types/object-hash": "^3.0.6",
@@ -117,11 +121,32 @@
     "@types/react-dom": "18.3.0",
     "@types/semver": "^7.5.8",
     "@types/yargs": "^17.0.32",
-    "typescript": "5.5.3"
+    "@zudoku/httpsnippet": "10.0.9",
+    "class-variance-authority": "0.7.0",
+    "clsx": "2.1.1",
+    "lucide-react": "0.378.0",
+    "oauth4webapi": "2.11.1",
+    "prism-react-renderer": "2.3.1",
+    "prismjs": "1.29.0",
+    "react-helmet-async": "2.0.5",
+    "react-markdown": "9.0.1",
+    "react-router-dom": "6.24.1",
+    "tailwind-merge": "2.3.0",
+    "typescript": "5.5.3",
+    "zustand": "4.5.4"
+  },
+  "peerDependencies": {
+    "react": ">18.0.0",
+    "react-dom": ">18.0.0"
+  },
+  "optionalDependencies": {
+    "@clerk/clerk-js": "5.2.2"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.node.json",
-    "test": "node --test --enable-source-maps",
-    "codegen": "graphql-codegen --config ./scripts/codegen.ts"
+    "build": "tsc --project tsconfig.json",
+    "build:vite": "vite build && pnpm run hack:fix-worker-paths",
+    "hack:fix-worker-paths": "node ./scripts/hack-worker.mjs",
+    "clean": "tsc --build --clean",
+    "test": "node --test --enable-source-maps"
   }
 }

package/src/app/App.tsx

@@ -1,62 +1,39 @@
 import "./main.css";
 
-import DevPortal from "./DevPortal.js";
-import { markdownPlugin } from "./plugins/markdown/index.js";
-import { openApiPlugin } from "./plugins/openapi/index.js";
+// Virtual config
+import config from "virtual:zudoku-config";
 
-import config from "./config.js";
-// import markdowns from "./markdowns.js";
+// Virtual Plugins
+import { configuredApiKeysPlugin } from "virtual:zudoku-api-keys-plugin";
+import { configuredApiPlugins } from "virtual:zudoku-api-plugins";
+import { configuredAuthProvider } from "virtual:zudoku-auth";
+import { configuredDocsPlugins } from "virtual:zudoku-docs-plugins";
+import { configuredRedirectPlugin } from "virtual:zudoku-redirect-plugin";
+
+// Base React Component
+import { DevPortal } from "zudoku/components";
+
+// IMPORTANT: This component must not contain tailwind classes
+// This directory is not processed by the tailwind plugin
 
 export default function App() {
   return (
     <DevPortal
       meta={{
-        headerTitle: config?.ui?.headerTitle ?? "Developer Portal",
-        pageTitle: config?.ui?.pageTitle ?? "%s | Dev Portal",
-        logo: config?.ui?.logo ?? "https://cdn.zuplo.com/www/favicon.png",
+        headerTitle: config.ui?.headerTitle ?? "Developer Portal",
+        pageTitle: config.ui?.pageTitle ?? "%s | Dev Portal",
+        logo: config.ui?.logo ?? "https://cdn.zuplo.com/www/favicon.png",
         favicon:
-          config?.ui?.metadata?.favicon ??
+          config.ui?.metadata?.favicon ??
           "https://cdn.zuplo.com/www/favicon.png",
       }}
       navigation={config.navigation ?? []}
-      // authentication={
-      //   config.authentication
-      //     ? getAuthProvider(config.authentication)
-      //     : undefined
-      // }
+      authentication={configuredAuthProvider}
       plugins={[
-        ...(config.docs
-          ? Array.isArray(config.docs)
-            ? config.docs
-            : [config.docs]
-          : []
-        ).map((docs) =>
-          markdownPlugin({
-            markdownFiles: docs?.files ?? {},
-          }),
-        ),
-        ...(config.apis
-          ? Array.isArray(config.apis)
-            ? config.apis
-            : [config.apis]
-          : []
-        ).map((api) => openApiPlugin(api)),
-        //     if (!accessToken) {
-        //       return;
-        //     }
-
-        //     const consumers = await fetch(
-        //       "https://zudoku-customer-main-b36fa2f.d2.zuplo.dev/v1/developer/api-keys",
-        //       {
-        //         headers: {
-        //           Authorization: `Bearer ${accessToken}`,
-        //         },
-        //       },
-        //     );
-
-        //     return { consumers: [await consumers.json()] };
-        //   },
-        // }),
+        ...configuredDocsPlugins,
+        ...configuredApiPlugins,
+        configuredApiKeysPlugin,
+        configuredRedirectPlugin,
       ]}
     />
   );

package/src/app/main.css

@@ -23,6 +23,7 @@
 
   html {
     scroll-padding-block: var(--scroll-padding);
+    scrollbar-gutter: stable;
   }
 
   body {

package/src/app/main.tsx

@@ -1,22 +1,18 @@
-import React from "react";
-import ReactDOM from "react-dom/client";
+import log from "loglevel";
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
 import App from "./App.js";
 
-// if (import.meta.env.DEV) {
-//   const { default: wdyr } = await import(
-//     "@welldone-software/why-did-you-render"
-//   );
-//
-//   wdyr(React, {
-//     include: [/.*/],
-//     exclude: [/^BrowserRouter/, /^Link/, /^Route/],
-//     trackHooks: true,
-//     trackAllPureComponents: true,
-//   });
-// }
+log.setDefaultLevel("silent");
 
-ReactDOM.createRoot(document.getElementById("root")!).render(
-  <React.StrictMode>
+if (import.meta.env.DEV) {
+  log.setLevel("debug");
+} else if (localStorage.getItem("ENABLE_DEBUG_LOGS")) {
+  log.setLevel("debug");
+}
+
+createRoot(document.getElementById("root")!).render(
+  <StrictMode>
     <App />
-  </React.StrictMode>,
+  </StrictMode>,
 );

package/src/lib/authentication/Callback.tsx

@@ -0,0 +1,31 @@
+import { useQuery } from "@tanstack/react-query";
+import { Navigate } from "react-router-dom";
+import { useDevPortal } from "../components/context/DevPortalProvider.js";
+import {
+  DevPortalContext,
+  SessionProfileState,
+} from "../core/DevPortalContext.js";
+
+export function Callback({
+  handleCallback,
+}: {
+  handleCallback: (
+    url: URL,
+    context: DevPortalContext,
+  ) => Promise<SessionProfileState>;
+}) {
+  const context = useDevPortal();
+  const callback = useQuery({
+    queryFn: () => handleCallback(new URL(window.location.href), context),
+    retry: 0,
+    queryKey: ["auth-callback"],
+  });
+
+  if (callback.isPending) {
+    return <div>Loading...</div>;
+  } else if (callback.error) {
+    return <div>Error: {JSON.stringify(callback.error)}</div>;
+  }
+
+  return <Navigate to="/" replace={true} />;
+}

package/src/lib/authentication/auth0.tsx

@@ -0,0 +1,18 @@
+import { Auth0AuthenticationConfig } from "../../config/config.js";
+import { NavigationPlugin } from "../core/plugins.js";
+import { AuthenticationProvider } from "./authentication.js";
+import openIdAuth from "./openid.js";
+
+const auth0Provider = ({
+  domain,
+  clientId,
+  audience,
+}: Auth0AuthenticationConfig): AuthenticationProvider & NavigationPlugin =>
+  openIdAuth({
+    type: "openid",
+    issuer: `https://${domain}`,
+    clientId: clientId,
+    audience: audience,
+  });
+
+export default auth0Provider;

package/src/lib/authentication/authentication.ts

@@ -0,0 +1,11 @@
+import { DevPortalContext } from "../../lib/core/DevPortalContext.js";
+import { NavigationPlugin } from "../../lib/core/plugins.js";
+
+export interface AuthenticationProvider extends NavigationPlugin {
+  initialize?(context: DevPortalContext): Promise<unknown>;
+  login(context: DevPortalContext): Promise<unknown>;
+  signRequest(request: Request, context: DevPortalContext): Promise<Request>;
+  /** @deprecated **/
+  getToken?: (context: DevPortalContext) => Promise<string | undefined>;
+  logout(context: DevPortalContext): void;
+}

package/src/lib/authentication/clerk.tsx

@@ -0,0 +1,56 @@
+import type { Clerk } from "@clerk/clerk-js";
+import { ClerkAuthenticationConfig } from "../../config/config.js";
+import { AuthenticationProvider } from "./authentication.js";
+
+const clerkAuth = ({
+  clerkPubKey,
+}: ClerkAuthenticationConfig): AuthenticationProvider => {
+  let clerkApi: Clerk;
+
+  const ensureLoaded = (async () => {
+    const { Clerk } = await import("@clerk/clerk-js");
+    clerkApi = new Clerk(clerkPubKey);
+
+    await clerkApi.load({});
+  })();
+
+  return {
+    initialize: async (context) => {
+      await ensureLoaded;
+
+      if (clerkApi.session) {
+        await context.setUserProfile({
+          isLoggedIn: true,
+          name: clerkApi.session.user.fullName ?? undefined,
+          email:
+            clerkApi.session.user.emailAddresses.at(0)?.emailAddress ??
+            undefined,
+        });
+      } else {
+        await context.setUserProfile({
+          isLoggedIn: false,
+        });
+      }
+    },
+    async signRequest(request: Request): Promise<Request> {
+      await ensureLoaded;
+      const token = await clerkApi.session?.getToken();
+      request.headers.set("Authorization", `Bearer ${token}`);
+      return request;
+    },
+    getToken: async () => {
+      await ensureLoaded;
+      const token = await clerkApi.session?.getToken();
+      return token ?? undefined;
+    },
+    logout: async () => {
+      await clerkApi.signOut();
+    },
+    login: async () => {
+      await clerkApi.redirectToSignIn();
+    },
+    getRoutes: () => [],
+  };
+};
+
+export default clerkAuth;

package/src/lib/authentication/openid.tsx

@@ -0,0 +1,206 @@
+import logger from "loglevel";
+import * as oauth from "oauth4webapi";
+import { OpenIDAuthenticationConfig } from "../../config/config.js";
+import { DevPortalContext } from "../core/DevPortalContext.js";
+import { NavigationPlugin } from "../core/plugins.js";
+import { AuthenticationProvider } from "./authentication.js";
+import { Callback } from "./Callback.js";
+
+const CALLBACK_URL_PATH = "/oauth/callback";
+
+async function getAuthServerByIssuer(issuer: URL | string) {
+  const issuerUrl = typeof issuer === "string" ? new URL(issuer) : issuer;
+  const response = await oauth.discoveryRequest(issuerUrl);
+  const server = await oauth.processDiscoveryResponse(issuerUrl, response);
+  return server;
+}
+
+async function getAuthServer({
+  issuer,
+  authorizationEndpoint,
+  tokenEndpoint,
+}: Pick<
+  OpenIDAuthenticationConfig,
+  "issuer" | "authorizationEndpoint" | "tokenEndpoint"
+>) {
+  return await getAuthServerByIssuer(issuer);
+  // : ({
+  //     issuer: new URL(authorizationEndpoint!).origin,
+  //     authorization_endpoint: authorizationEndpoint,
+  //     token_endpoint: tokenEndpoint,
+  //     code_challenge_methods_supported: [],
+  //   } satisfies oauth.AuthorizationServer);
+}
+
+const openIdAuth = ({
+  issuer,
+  authorizationEndpoint,
+  tokenEndpoint,
+  clientId,
+}: OpenIDAuthenticationConfig): AuthenticationProvider & NavigationPlugin => {
+  const client: oauth.Client = {
+    client_id: clientId,
+    token_endpoint_auth_method: "none",
+  };
+
+  async function handleCallback(url: URL, context: DevPortalContext) {
+    const searchParams = url.searchParams;
+    const state = searchParams.get("state");
+
+    // one eternity later, the user lands back on the redirect_uri
+    // Authorization Code Grant Request & Response
+    const codeVerifier = await context.sessionStorage.get("codeVerifier");
+
+    if (!codeVerifier) {
+      return {
+        isLoggedIn: false,
+      };
+    }
+
+    const authServer = await getAuthServer({
+      issuer: issuer,
+      authorizationEndpoint: authorizationEndpoint,
+      tokenEndpoint: tokenEndpoint,
+    });
+
+    const params = oauth.validateAuthResponse(
+      authServer,
+      client,
+      searchParams,
+      state ?? undefined,
+    );
+    if (oauth.isOAuth2Error(params)) {
+      logger.error("Error Response", params);
+      throw new Error(); // Handle OAuth 2.0 redirect error
+    }
+
+    const redirectUrl = new URL(url);
+    redirectUrl.pathname = CALLBACK_URL_PATH;
+    redirectUrl.search = "";
+
+    const response = await oauth.authorizationCodeGrantRequest(
+      authServer,
+      client,
+      params,
+      redirectUrl.toString(),
+      codeVerifier,
+    );
+
+    // @todo do we need to do these
+    // const challenges = oauth.parseWwwAuthenticateChallenges(response);
+    // if (challenges) {
+    //   for (const challenge of challenges) {
+    //     console.error("WWW-Authenticate Challenge", challenge);
+    //   }
+    //   throw new Error(); // Handle WWW-Authenticate Challenges as needed
+    // }
+    const oauthResult = await oauth.processAuthorizationCodeOAuth2Response(
+      authServer,
+      client,
+      response,
+    );
+
+    if (oauth.isOAuth2Error(oauthResult)) {
+      logger.error("Error Response", oauthResult);
+      throw new Error(oauthResult.error);
+    }
+
+    const userInfoResponse = await oauth.userInfoRequest(
+      authServer,
+      client,
+      oauthResult.access_token,
+    );
+    const userInfo = await userInfoResponse.json();
+
+    const profile = {
+      sub: userInfo.sub,
+      email: userInfo.email,
+      name: userInfo.name,
+      email_verified: userInfo.email_verified ?? false,
+      picture: userInfo.picture,
+      isLoggedIn: true,
+    };
+    void context.setUserProfile(profile);
+
+    return profile;
+  }
+
+  return {
+    logout: async (context) => {
+      await context.setUserProfile({ isLoggedIn: false });
+    },
+    login: async (context) => {
+      const code_challenge_method = "S256";
+      const authorizationServer = await getAuthServer({
+        issuer: issuer,
+        authorizationEndpoint,
+        tokenEndpoint,
+      });
+
+      if (!authorizationServer.authorization_endpoint) {
+        throw new Error("No authorization endpoint");
+      }
+
+      /**
+       * The following MUST be generated for every redirect to the authorization_endpoint. You must store
+       * the codeVerifier and nonce in the end-user session such that it can be recovered as the user
+       * gets redirected from the authorization server back to your application.
+       */
+      const codeVerifier = oauth.generateRandomCodeVerifier();
+      const codeChallenge =
+        await oauth.calculatePKCECodeChallenge(codeVerifier);
+
+      await context.sessionStorage.set("codeVerifier", codeVerifier);
+
+      // redirect user to as.authorization_endpoint
+      const authorizationUrl = new URL(
+        authorizationServer.authorization_endpoint,
+      );
+
+      const redirectUrl = new URL(context.url);
+      redirectUrl.pathname = CALLBACK_URL_PATH;
+      redirectUrl.search = "";
+
+      authorizationUrl.searchParams.set("client_id", client.client_id);
+      authorizationUrl.searchParams.set("redirect_uri", redirectUrl.toString());
+      authorizationUrl.searchParams.set("response_type", "code");
+      authorizationUrl.searchParams.set("scope", "openid+profile+email");
+      authorizationUrl.searchParams.set("code_challenge", codeChallenge);
+      authorizationUrl.searchParams.set(
+        "code_challenge_method",
+        code_challenge_method,
+      );
+
+      /**
+       * We cannot be sure the AS supports PKCE so we're going to use state too. Use of PKCE is
+       * backwards compatible even if the AS doesn't support it which is why we're using it regardless.
+       */
+      if (
+        authorizationServer.code_challenge_methods_supported?.includes(
+          "S256",
+        ) !== true
+      ) {
+        const state = oauth.generateRandomState();
+        authorizationUrl.searchParams.set("state", state);
+      }
+
+      // now redirect the user to authorizationUrl.href
+      location.href = authorizationUrl.href;
+    },
+    signRequest(request: Request, context: DevPortalContext): Promise<Request> {
+      // check if token is expired
+
+      return Promise.resolve(request);
+    },
+    getRoutes: () => {
+      return [
+        {
+          path: CALLBACK_URL_PATH,
+          element: <Callback handleCallback={handleCallback} />,
+        },
+      ];
+    },
+  } satisfies AuthenticationProvider & NavigationPlugin;
+};
+
+export default openIdAuth;