@lukoweb/apitogo 0.1.24 → 0.1.38

package/src/lib/core/plugins.ts

@@ -1,138 +1,138 @@
-import type { LucideIcon } from "lucide-react";
-import type { HTMLAttributeAnchorTarget, ReactNode } from "react";
-import type { Location, RouteObject } from "react-router";
-import type { Navigation } from "../../config/validators/NavigationSchema.js";
-import type { ProtectedRoutesInput } from "../../config/validators/ProtectedRoutesSchema.js";
-import type { ZudokuConfig } from "../../config/validators/ZudokuConfig.js";
-import type { AuthenticationPlugin } from "../authentication/authentication.js";
-import type { MdxComponentsType } from "../util/MdxComponents.js";
-import type {
-  ApiIdentity,
-  ApitogoEvents,
-  ZudokuContext,
-} from "./ZudokuContext.js";
-export { runPluginTransformConfig } from "./transform-config.js";
-
-export type ApitogoPlugin =
-  | CommonPlugin
-  | ProfileMenuPlugin
-  | NavigationPlugin
-  | ApiIdentityPlugin
-  | SearchProviderPlugin
-  | EventConsumerPlugin
-  | AuthenticationPlugin
-  | TransformConfigPlugin;
-
-export type { AuthenticationPlugin, RouteObject };
-
-export interface NavigationPlugin {
-  getRoutes: () => RouteObject[];
-  getNavigation?: (path: string, context: ZudokuContext) => Promise<Navigation>;
-  getProtectedRoutes?: () => ProtectedRoutesInput;
-}
-
-export const createApiIdentityPlugin = (
-  plugin: ApiIdentityPlugin,
-): ApiIdentityPlugin => plugin;
-
-export const createProfileMenuPlugin = (
-  plugin: ProfileMenuPlugin,
-): ProfileMenuPlugin => plugin;
-
-export interface ApiIdentityPlugin {
-  getIdentities: (context: ZudokuContext) => Promise<ApiIdentity[]>;
-}
-
-export interface SearchProviderPlugin {
-  renderSearch: (o: {
-    isOpen: boolean;
-    onClose: () => void;
-  }) => React.JSX.Element | null;
-}
-
-export interface ProfileMenuPlugin {
-  getProfileMenuItems: (context: ZudokuContext) => ProfileNavigationItem[];
-}
-
-export type ProfileNavigationItem = {
-  label: string;
-  path?: string;
-  target?: HTMLAttributeAnchorTarget;
-  weight?: number;
-  category?: "top" | "middle" | "bottom";
-  children?: ProfileNavigationItem[];
-  icon?: LucideIcon;
-};
-
-export interface ConfigHookContext {
-  mode: typeof process.env.ZUDOKU_ENV;
-  rootDir: string;
-  configPath: string;
-}
-
-export interface TransformConfigContext {
-  config: ZudokuConfig;
-  merge: <T extends Partial<ZudokuConfig>>(partial: T) => ZudokuConfig & T;
-}
-
-export interface TransformConfigPlugin {
-  transformConfig?: (
-    context: TransformConfigContext,
-  ) => ZudokuConfig | void | Promise<ZudokuConfig | void>;
-}
-
-export interface CommonPlugin {
-  initialize?: (
-    context: ZudokuContext,
-  ) => Promise<void | boolean> | void | boolean;
-  getHead?: (args: { location: Location }) => ReactNode | undefined;
-  getMdxComponents?: () => MdxComponentsType;
-}
-
-export type EventConsumerPlugin<Event extends ApitogoEvents = ApitogoEvents> = {
-  events: { [K in keyof Event]?: Event[K] };
-};
-
-export const isEventConsumerPlugin = (
-  obj: ApitogoPlugin,
-): obj is EventConsumerPlugin =>
-  "events" in obj && typeof obj.events === "object";
-
-export const isProfileMenuPlugin = (
-  obj: ApitogoPlugin,
-): obj is ProfileMenuPlugin =>
-  "getProfileMenuItems" in obj && typeof obj.getProfileMenuItems === "function";
-
-export const isNavigationPlugin = (
-  obj: ApitogoPlugin,
-): obj is NavigationPlugin =>
-  "getRoutes" in obj && typeof obj.getRoutes === "function";
-
-export const isAuthenticationPlugin = (
-  obj: ApitogoPlugin,
-): obj is AuthenticationPlugin =>
-  "signUp" in obj && typeof obj.signUp === "function";
-
-export const isSearchPlugin = (
-  obj: ApitogoPlugin,
-): obj is SearchProviderPlugin =>
-  "renderSearch" in obj && typeof obj.renderSearch === "function";
-
-export const needsInitialization = (obj: ApitogoPlugin): obj is CommonPlugin =>
-  "initialize" in obj && typeof obj.initialize === "function";
-
-export const hasHead = (obj: ApitogoPlugin): obj is CommonPlugin =>
-  "getHead" in obj && typeof obj.getHead === "function";
-
-export const isMdxProviderPlugin = (obj: ApitogoPlugin): obj is CommonPlugin =>
-  "getMdxComponents" in obj && typeof obj.getMdxComponents === "function";
-
-export const isApiIdentityPlugin = (
-  obj: ApitogoPlugin,
-): obj is ApiIdentityPlugin =>
-  "getIdentities" in obj && typeof obj.getIdentities === "function";
-
-export const isTransformConfigPlugin = (
-  obj: ApitogoPlugin,
-): obj is TransformConfigPlugin =>
-  "transformConfig" in obj && typeof obj.transformConfig === "function";
+import type { LucideIcon } from "lucide-react";
+import type { HTMLAttributeAnchorTarget, ReactNode } from "react";
+import type { Location, RouteObject } from "react-router";
+import type { Navigation } from "../../config/validators/NavigationSchema.js";
+import type { ProtectedRoutesInput } from "../../config/validators/ProtectedRoutesSchema.js";
+import type { ZudokuConfig } from "../../config/validators/ZudokuConfig.js";
+import type { AuthenticationPlugin } from "../authentication/authentication.js";
+import type { MdxComponentsType } from "../util/MdxComponents.js";
+import type {
+  ApiIdentity,
+  ApitogoEvents,
+  ZudokuContext,
+} from "./ZudokuContext.js";
+export { runPluginTransformConfig } from "./transform-config.js";
+
+export type ApitogoPlugin =
+  | CommonPlugin
+  | ProfileMenuPlugin
+  | NavigationPlugin
+  | ApiIdentityPlugin
+  | SearchProviderPlugin
+  | EventConsumerPlugin
+  | AuthenticationPlugin
+  | TransformConfigPlugin;
+
+export type { AuthenticationPlugin, RouteObject };
+
+export interface NavigationPlugin {
+  getRoutes: () => RouteObject[];
+  getNavigation?: (path: string, context: ZudokuContext) => Promise<Navigation>;
+  getProtectedRoutes?: () => ProtectedRoutesInput;
+}
+
+export const createApiIdentityPlugin = (
+  plugin: ApiIdentityPlugin,
+): ApiIdentityPlugin => plugin;
+
+export const createProfileMenuPlugin = (
+  plugin: ProfileMenuPlugin,
+): ProfileMenuPlugin => plugin;
+
+export interface ApiIdentityPlugin {
+  getIdentities: (context: ZudokuContext) => Promise<ApiIdentity[]>;
+}
+
+export interface SearchProviderPlugin {
+  renderSearch: (o: {
+    isOpen: boolean;
+    onClose: () => void;
+  }) => React.JSX.Element | null;
+}
+
+export interface ProfileMenuPlugin {
+  getProfileMenuItems: (context: ZudokuContext) => ProfileNavigationItem[];
+}
+
+export type ProfileNavigationItem = {
+  label: string;
+  path?: string;
+  target?: HTMLAttributeAnchorTarget;
+  weight?: number;
+  category?: "top" | "middle" | "bottom";
+  children?: ProfileNavigationItem[];
+  icon?: LucideIcon;
+};
+
+export interface ConfigHookContext {
+  mode: typeof process.env.ZUDOKU_ENV;
+  rootDir: string;
+  configPath: string;
+}
+
+export interface TransformConfigContext {
+  config: ZudokuConfig;
+  merge: <T extends Partial<ZudokuConfig>>(partial: T) => ZudokuConfig & T;
+}
+
+export interface TransformConfigPlugin {
+  transformConfig?: (
+    context: TransformConfigContext,
+  ) => ZudokuConfig | void | Promise<ZudokuConfig | void>;
+}
+
+export interface CommonPlugin {
+  initialize?: (
+    context: ZudokuContext,
+  ) => Promise<void | boolean> | void | boolean;
+  getHead?: (args: { location: Location }) => ReactNode | undefined;
+  getMdxComponents?: () => MdxComponentsType;
+}
+
+export type EventConsumerPlugin<Event extends ApitogoEvents = ApitogoEvents> = {
+  events: { [K in keyof Event]?: Event[K] };
+};
+
+export const isEventConsumerPlugin = (
+  obj: ApitogoPlugin,
+): obj is EventConsumerPlugin =>
+  "events" in obj && typeof obj.events === "object";
+
+export const isProfileMenuPlugin = (
+  obj: ApitogoPlugin,
+): obj is ProfileMenuPlugin =>
+  "getProfileMenuItems" in obj && typeof obj.getProfileMenuItems === "function";
+
+export const isNavigationPlugin = (
+  obj: ApitogoPlugin,
+): obj is NavigationPlugin =>
+  "getRoutes" in obj && typeof obj.getRoutes === "function";
+
+export const isAuthenticationPlugin = (
+  obj: ApitogoPlugin,
+): obj is AuthenticationPlugin =>
+  "signUp" in obj && typeof obj.signUp === "function";
+
+export const isSearchPlugin = (
+  obj: ApitogoPlugin,
+): obj is SearchProviderPlugin =>
+  "renderSearch" in obj && typeof obj.renderSearch === "function";
+
+export const needsInitialization = (obj: ApitogoPlugin): obj is CommonPlugin =>
+  "initialize" in obj && typeof obj.initialize === "function";
+
+export const hasHead = (obj: ApitogoPlugin): obj is CommonPlugin =>
+  "getHead" in obj && typeof obj.getHead === "function";
+
+export const isMdxProviderPlugin = (obj: ApitogoPlugin): obj is CommonPlugin =>
+  "getMdxComponents" in obj && typeof obj.getMdxComponents === "function";
+
+export const isApiIdentityPlugin = (
+  obj: ApitogoPlugin,
+): obj is ApiIdentityPlugin =>
+  "getIdentities" in obj && typeof obj.getIdentities === "function";
+
+export const isTransformConfigPlugin = (
+  obj: ApitogoPlugin,
+): obj is TransformConfigPlugin =>
+  "transformConfig" in obj && typeof obj.transformConfig === "function";

package/src/lib/core/react-query.ts

@@ -1 +1 @@
-export * from "@tanstack/react-query";
+export * from "@tanstack/react-query";

package/src/lib/core/router.ts

@@ -1 +1 @@
-export * from "react-router";
+export * from "react-router";

package/src/lib/core/transform-config.ts

@@ -1,67 +1,67 @@
-import { isValidElement } from "react";
-import type { ZudokuConfig } from "../../config/validators/ZudokuConfig.js";
-import { isTransformConfigPlugin } from "./plugins.js";
-
-export const isPlainObject = (
-  value: unknown,
-): value is Record<string, unknown> =>
-  typeof value === "object" &&
-  value !== null &&
-  !Array.isArray(value) &&
-  Object.getPrototypeOf(value) === Object.prototype;
-
-export const mergeConfig = <
-  T extends Record<string, unknown>,
-  S extends Record<string, unknown>,
->(
-  target: T,
-  source: S,
-): T & S => {
-  const result = { ...target } as T & S;
-
-  for (const key of Object.keys(source) as (keyof S)[]) {
-    const sourceValue = source[key];
-    const targetValue = target[key as keyof T];
-
-    // Don't merge React elements, arrays, or non-plain objects - just replace
-    if (
-      isValidElement(sourceValue) ||
-      Array.isArray(sourceValue) ||
-      !isPlainObject(sourceValue)
-    ) {
-      (result as Record<string, unknown>)[key as string] = sourceValue;
-    } else if (isPlainObject(targetValue)) {
-      (result as Record<string, unknown>)[key as string] = mergeConfig(
-        targetValue,
-        sourceValue,
-      );
-    } else {
-      (result as Record<string, unknown>)[key as string] = sourceValue;
-    }
-  }
-
-  return result;
-};
-
-export const runPluginTransformConfig = async <T extends ZudokuConfig>(
-  config: T,
-): Promise<T> => {
-  const plugins = config.plugins ?? [];
-
-  let result = config;
-
-  for (const plugin of plugins.filter(isTransformConfigPlugin)) {
-    const merge = <T extends Record<string, unknown>>(partial: T) =>
-      mergeConfig(result, partial);
-
-    const transformed = await plugin.transformConfig?.({
-      config: result,
-      merge,
-    });
-    if (!transformed) continue;
-
-    result = transformed as T;
-  }
-
-  return result;
-};
+import { isValidElement } from "react";
+import type { ZudokuConfig } from "../../config/validators/ZudokuConfig.js";
+import { isTransformConfigPlugin } from "./plugins.js";
+
+export const isPlainObject = (
+  value: unknown,
+): value is Record<string, unknown> =>
+  typeof value === "object" &&
+  value !== null &&
+  !Array.isArray(value) &&
+  Object.getPrototypeOf(value) === Object.prototype;
+
+export const mergeConfig = <
+  T extends Record<string, unknown>,
+  S extends Record<string, unknown>,
+>(
+  target: T,
+  source: S,
+): T & S => {
+  const result = { ...target } as T & S;
+
+  for (const key of Object.keys(source) as (keyof S)[]) {
+    const sourceValue = source[key];
+    const targetValue = target[key as keyof T];
+
+    // Don't merge React elements, arrays, or non-plain objects - just replace
+    if (
+      isValidElement(sourceValue) ||
+      Array.isArray(sourceValue) ||
+      !isPlainObject(sourceValue)
+    ) {
+      (result as Record<string, unknown>)[key as string] = sourceValue;
+    } else if (isPlainObject(targetValue)) {
+      (result as Record<string, unknown>)[key as string] = mergeConfig(
+        targetValue,
+        sourceValue,
+      );
+    } else {
+      (result as Record<string, unknown>)[key as string] = sourceValue;
+    }
+  }
+
+  return result;
+};
+
+export const runPluginTransformConfig = async <T extends ZudokuConfig>(
+  config: T,
+): Promise<T> => {
+  const plugins = config.plugins ?? [];
+
+  let result = config;
+
+  for (const plugin of plugins.filter(isTransformConfigPlugin)) {
+    const merge = <T extends Record<string, unknown>>(partial: T) =>
+      mergeConfig(result, partial);
+
+    const transformed = await plugin.transformConfig?.({
+      config: result,
+      merge,
+    });
+    if (!transformed) continue;
+
+    result = transformed as T;
+  }
+
+  return result;
+};

package/src/lib/demo/DemoAnnouncement.tsx

@@ -1,17 +1,17 @@
-export const DemoAnnouncement = () => {
-  return (
-    <div className="text-center">
-      This demo version of your OpenAPI isn't as fast or flexible as
-      self-hosting.{" "}
-      <a
-        href="https://github.com/zuplo/zudoku"
-        className="underline hover:white"
-      >
-        Get started here
-      </a>{" "}
-      to see Zudoku at full tilt.
-    </div>
-  );
-};
-
-export default DemoAnnouncement;
+export const DemoAnnouncement = () => {
+  return (
+    <div className="text-center">
+      This demo version of your OpenAPI isn't as fast or flexible as
+      self-hosting.{" "}
+      <a
+        href="https://github.com/zuplo/zudoku"
+        className="underline hover:white"
+      >
+        Get started here
+      </a>{" "}
+      to see Zudoku at full tilt.
+    </div>
+  );
+};
+
+export default DemoAnnouncement;

package/src/lib/errors/ErrorAlert.tsx

@@ -1,28 +1,28 @@
-import { DeveloperHint } from "../components/DeveloperHint.js";
-import { Heading } from "../components/Heading.js";
-import { Typography } from "../components/Typography.js";
-import { ZudokuError } from "../util/invariant.js";
-
-export function ErrorAlert({ error }: { error: unknown }) {
-  const message =
-    error instanceof Error ? error.message : "Something went wrong";
-
-  const hint = error instanceof ZudokuError ? error.developerHint : undefined;
-  const title =
-    error instanceof ZudokuError ? error.title : "Something went wrong";
-  const stack = error instanceof Error ? error.stack : undefined;
-  const cause = error instanceof Error ? error.cause : undefined;
-
-  const stringError = cause instanceof Error ? String(cause.stack) : stack;
-
-  return (
-    <Typography className="grid grid-cols-1 max-w-none! pt-(--padding-content-top)">
-      <Heading level={1}>{title}</Heading>
-      Error: {message}
-      {hint && <DeveloperHint className="mb-4">{hint}</DeveloperHint>}
-      {stringError && (
-        <pre className="max-h-[400px] [&>pre]:p-4">{stringError}</pre>
-      )}
-    </Typography>
-  );
-}
+import { DeveloperHint } from "../components/DeveloperHint.js";
+import { Heading } from "../components/Heading.js";
+import { Typography } from "../components/Typography.js";
+import { ZudokuError } from "../util/invariant.js";
+
+export function ErrorAlert({ error }: { error: unknown }) {
+  const message =
+    error instanceof Error ? error.message : "Something went wrong";
+
+  const hint = error instanceof ZudokuError ? error.developerHint : undefined;
+  const title =
+    error instanceof ZudokuError ? error.title : "Something went wrong";
+  const stack = error instanceof Error ? error.stack : undefined;
+  const cause = error instanceof Error ? error.cause : undefined;
+
+  const stringError = cause instanceof Error ? String(cause.stack) : stack;
+
+  return (
+    <Typography className="grid grid-cols-1 max-w-none! pt-(--padding-content-top)">
+      <Heading level={1}>{title}</Heading>
+      Error: {message}
+      {hint && <DeveloperHint className="mb-4">{hint}</DeveloperHint>}
+      {stringError && (
+        <pre className="max-h-[400px] [&>pre]:p-4">{stringError}</pre>
+      )}
+    </Typography>
+  );
+}

package/src/lib/errors/RouterError.tsx

@@ -1,18 +1,18 @@
-import { isRouteErrorResponse, useRouteError } from "react-router";
-import { NotFoundPage } from "../components/NotFoundPage.js";
-import { cn } from "../util/cn.js";
-import { ErrorAlert } from "./ErrorAlert.js";
-
-export function RouterError({ className }: { className?: string }) {
-  const error = useRouteError();
-
-  if (isRouteErrorResponse(error) && error.status === 404) {
-    return <NotFoundPage />;
-  }
-
-  return (
-    <div className={cn("mx-4 max-w-2xl", className)} data-pagefind-ignore="all">
-      <ErrorAlert error={error} />
-    </div>
-  );
-}
+import { isRouteErrorResponse, useRouteError } from "react-router";
+import { NotFoundPage } from "../components/NotFoundPage.js";
+import { cn } from "../util/cn.js";
+import { ErrorAlert } from "./ErrorAlert.js";
+
+export function RouterError({ className }: { className?: string }) {
+  const error = useRouteError();
+
+  if (isRouteErrorResponse(error) && error.status === 404) {
+    return <NotFoundPage />;
+  }
+
+  return (
+    <div className={cn("mx-4 max-w-2xl", className)} data-pagefind-ignore="all">
+      <ErrorAlert error={error} />
+    </div>
+  );
+}

package/src/lib/errors/ServerError.tsx

@@ -1,5 +1,5 @@
-import { ErrorAlert } from "./ErrorAlert.js";
-
-export function ServerError({ error }: { error: unknown }) {
-  return <ErrorAlert error={error} />;
-}
+import { ErrorAlert } from "./ErrorAlert.js";
+
+export function ServerError({ error }: { error: unknown }) {
+  return <ErrorAlert error={error} />;
+}

package/src/lib/errors/TopLevelError.tsx

@@ -1,6 +1,6 @@
-import type { FallbackProps } from "react-error-boundary";
-import { ErrorAlert } from "./ErrorAlert.js";
-
-export function TopLevelError({ error }: FallbackProps) {
-  return <ErrorAlert error={error} />;
-}
+import type { FallbackProps } from "react-error-boundary";
+import { ErrorAlert } from "./ErrorAlert.js";
+
+export function TopLevelError({ error }: FallbackProps) {
+  return <ErrorAlert error={error} />;
+}

package/src/lib/hooks/index.ts

@@ -1,13 +1,13 @@
-export { useMDXComponents } from "@mdx-js/react";
-export { useTheme } from "next-themes";
-export {
-  useAuth,
-  useRefreshUserProfile,
-  useVerifiedEmail,
-} from "../authentication/hook.js";
-export { CACHE_KEYS, useCache } from "../components/cache.js";
-export { useApitogo } from "../components/context/ZudokuContext.js";
-/** @deprecated Use {@link useApitogo} instead. */
-export { useZudoku } from "../components/context/ZudokuContext.js";
-export { useExposedProps } from "../util/useExposedProps.js";
-export { useEvent } from "./useEvent.js";
+export { useMDXComponents } from "@mdx-js/react";
+export { useTheme } from "next-themes";
+export {
+  useAuth,
+  useRefreshUserProfile,
+  useVerifiedEmail,
+} from "../authentication/hook.js";
+export { CACHE_KEYS, useCache } from "../components/cache.js";
+export { useApitogo } from "../components/context/ZudokuContext.js";
+/** @deprecated Use {@link useApitogo} instead. */
+export { useZudoku } from "../components/context/ZudokuContext.js";
+export { useExposedProps } from "../util/useExposedProps.js";
+export { useEvent } from "./useEvent.js";