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

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "zudoku",
-  "version": "0.1.1-dev.9",
+  "version": "0.3.0-dev.3",
   "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,23 @@
     ".": {
       "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"
+    },
+    "./auth/openid": {
+      "import": "./lib/zudoku.auth-openid.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,84 +44,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",
     "@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",
+    "@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",
+    "@vitejs/plugin-react": "4.3.1",
     "autoprefixer": "10.4.19",
-    "chalk": "5.3.0",
-    "class-variance-authority": "0.7.0",
-    "clsx": "2.1.1",
+    "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",
     "object-hash": "3.0.0",
     "openapi-types": "12.1.3",
-    "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",
+    "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",
+    "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.4"
+    "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",
@@ -115,11 +124,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

@@ -4,27 +4,37 @@ import "./main.css";
 import config from "virtual:zudoku-config";
 
 // 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 "./DevPortal.js";
+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={configuredAuthProvider}
-      plugins={[...configuredDocsPlugins, ...configuredApiPlugins]}
+      plugins={[
+        ...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,9 +1,18 @@
-import React from "react";
+import log from "loglevel";
+import { StrictMode } from "react";
 import { createRoot } from "react-dom/client";
 import App from "./App.js";
 
+log.setDefaultLevel("silent");
+
+if (import.meta.env.DEV) {
+  log.setLevel("debug");
+} else if (localStorage.getItem("ENABLE_DEBUG_LOGS")) {
+  log.setLevel("debug");
+}
+
 createRoot(document.getElementById("root")!).render(
-  <React.StrictMode>
+  <StrictMode>
     <App />
-  </React.StrictMode>,
+  </StrictMode>,
 );

package/src/lib/authentication/Callback.tsx

@@ -0,0 +1,60 @@
+import { useEffect, useRef, useState } from "react";
+import { useNavigate } from "../core/router.js";
+import { OAuthAuthorizationError } from "./errors.js";
+
+export function Callback({
+  handleCallback,
+}: {
+  handleCallback: () => Promise<void>;
+}) {
+  const didInitialize = useRef(false);
+  const [error, setError] = useState<Error | undefined>(undefined);
+  const navigate = useNavigate();
+
+  // This should not use react query, etc. It is important that it
+  // only ever runs once. The didInitialize ref keeps it from double
+  // initializing in dev mode with ReactStrict enabled.
+  useEffect(() => {
+    if (didInitialize.current) {
+      return;
+    }
+    didInitialize.current = true;
+    handleCallback()
+      .then(() => {
+        // TODO: Handle return url, state, etc
+        navigate("/");
+      })
+      .catch((err) => {
+        setError(err);
+      });
+  }, []);
+
+  if (error) {
+    if (error instanceof OAuthAuthorizationError) {
+      return (
+        <div>
+          <h2>Error</h2>
+          <pre>
+            {error.error.error}
+
+            {error.error.error_description}
+
+            {error.error.error_uri}
+          </pre>
+        </div>
+      );
+    }
+    return (
+      <div>
+        <h2>Error</h2>
+        <pre>
+          {error.message}
+
+          {error.stack}
+        </pre>
+      </div>
+    );
+  }
+
+  return <div>Loading...</div>;
+}

package/src/lib/authentication/authentication.ts

@@ -0,0 +1,19 @@
+import {
+  InitializationPlugin,
+  NavigationPlugin,
+} from "../../lib/core/plugins.js";
+
+type AuthenticationPlugin = NavigationPlugin & InitializationPlugin;
+
+export interface AuthenticationProvider extends AuthenticationPlugin {
+  login(): Promise<void>;
+  getAccessToken(): Promise<string>;
+  logout(): Promise<void>;
+}
+
+/**
+ * Function to get an initialized AuthenticationProvider
+ */
+export interface AuthenticationProviderInitializer<TConfig> {
+  (config: TConfig): AuthenticationProvider;
+}

package/src/lib/authentication/errors.ts

@@ -0,0 +1,21 @@
+export class AuthorizationError extends Error {}
+
+interface OAuthError {
+  readonly error: string;
+  readonly error_description?: string;
+  readonly error_uri?: string;
+  readonly algs?: string;
+  readonly scope?: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  readonly [parameter: string]: any | undefined;
+}
+
+export class OAuthAuthorizationError extends AuthorizationError {
+  constructor(
+    message: string,
+    public error: OAuthError,
+    options?: ErrorOptions,
+  ) {
+    super(message, options);
+  }
+}

package/src/lib/authentication/hook.ts

@@ -0,0 +1,33 @@
+import { useDevPortal } from "../components/context/DevPortalProvider.js";
+import { useAuthState } from "./state.js";
+
+export const useAuth = () => {
+  const { authentication } = useDevPortal();
+  const authState = useAuthState();
+  const isAuthEnabled = typeof authentication !== "undefined";
+
+  return {
+    isAuthEnabled,
+    profile: authState.profile,
+    isAuthenticated: authState.profile,
+
+    login: async () => {
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+      // TODO: Should handle errors/state
+      await authentication.login();
+    },
+
+    logout: async () => {
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+      // TODO: Should handle errors/state
+      await authentication.logout();
+
+      // Redirect to home
+      window.location.href = "/";
+    },
+  };
+};

package/src/lib/authentication/providers/auth0.tsx

@@ -0,0 +1,52 @@
+import { Auth0AuthenticationConfig } from "../../../config/config.js";
+import { AuthenticationProviderInitializer } from "../authentication.js";
+import { useAuthState } from "../state.js";
+import { OpenIDAuthenticationProvider } from "./openid.js";
+
+class Auth0AuthenticationProvider extends OpenIDAuthenticationProvider {
+  override async logout(): Promise<void> {
+    useAuthState.setState({
+      isAuthenticated: false,
+      profile: undefined,
+    });
+    const as = await this.getAuthServer();
+
+    const redirectUrl = new URL(window.location.href);
+    redirectUrl.pathname = this.logoutRedirectUrlPath;
+
+    // SEE: https://auth0.com/docs/authenticate/login/logout/log-users-out-of-auth0
+    // For Auth0 tenants created on or after 14 November 2023, RP-Initiated
+    // Logout End Session Endpoint Discovery is enabled by default.
+    // Otherwise we fallback to the old non-compliant logout
+
+    let logoutUrl: URL;
+    // The endSessionEndpoint is set, the IdP supports some form of logout,
+    // so we use the IdP logout. Otherwise, just redirect the user to home
+    if (as.end_session_endpoint) {
+      logoutUrl = new URL(as.end_session_endpoint);
+      // TODO: get id_token and set hint
+      // const { id_token } = session;
+      // if (id_token) {
+      //   logoutUrl.searchParams.set("id_token_hint", id_token);
+      // }
+      logoutUrl.searchParams.set(
+        "post_logout_redirect_uri",
+        redirectUrl.toString(),
+      );
+    } else {
+      logoutUrl = new URL(`${this.issuer}oidc/logout`);
+    }
+  }
+}
+
+const auth0Auth: AuthenticationProviderInitializer<
+  Auth0AuthenticationConfig
+> = ({ domain, clientId, audience }) =>
+  new Auth0AuthenticationProvider({
+    type: "openid",
+    issuer: `https://${domain}`,
+    clientId: clientId,
+    audience: audience,
+  });
+
+export default auth0Auth;

package/src/lib/authentication/providers/clerk.tsx

@@ -0,0 +1,64 @@
+import type { Clerk } from "@clerk/clerk-js";
+import { ClerkAuthenticationConfig } from "../../../config/config.js";
+import { AuthenticationProviderInitializer } from "../authentication.js";
+import { useAuthState } from "../state.js";
+
+const clerkAuth: AuthenticationProviderInitializer<
+  ClerkAuthenticationConfig
+> = ({ clerkPubKey }) => {
+  let clerkApi: Clerk;
+
+  const ensureLoaded = (async () => {
+    const { Clerk } = await import("@clerk/clerk-js");
+    clerkApi = new Clerk(clerkPubKey);
+
+    await clerkApi.load({});
+  })();
+
+  async function getAccessToken() {
+    await ensureLoaded;
+    if (!clerkApi.session) {
+      throw new Error("No session available");
+    }
+    const response = await clerkApi.session.getToken();
+    if (!response) {
+      throw new Error("Could not get access token from Clerk");
+    }
+    return response;
+  }
+
+  return {
+    initialize: async () => {
+      await ensureLoaded;
+
+      if (clerkApi.session) {
+        useAuthState.setState({
+          isAuthenticated: true,
+          profile: {
+            sub: clerkApi.session.user.id,
+            name: clerkApi.session.user.fullName ?? undefined,
+            email: clerkApi.session.user.emailAddresses[0]?.emailAddress,
+            emailVerified: false, // TODO: Check this
+            // emailVerified: clerkApi.session.user.hasVerifiedEmailAddress,
+            pictureUrl: clerkApi.session.user.imageUrl,
+          },
+        });
+      } else {
+        useAuthState.setState({
+          isAuthenticated: false,
+          profile: undefined,
+        });
+      }
+    },
+    getAccessToken,
+    logout: async () => {
+      await clerkApi.signOut();
+    },
+    login: async () => {
+      await clerkApi.redirectToSignIn();
+    },
+    getRoutes: () => [],
+  };
+};
+
+export default clerkAuth;