@lukoweb/apitogo 0.1.20 → 0.1.22

package/src/lib/core/ZudokuContext.ts

@@ -32,10 +32,10 @@ import {
   isProfileMenuPlugin,
   needsInitialization,
   type ProfileNavigationItem,
-  type ZudokuPlugin,
+  type ApitogoPlugin,
 } from "./plugins.js";
 
-export interface ZudokuEvents {
+export interface ApitogoEvents {
   location: (event: { from?: Location; to: Location }) => void;
   auth: (auth: { prev: AuthState; next: AuthState }) => void;
 }
@@ -108,7 +108,7 @@ export type ZudokuContextOptions = {
   authentication?: AuthenticationPlugin;
   navigation?: Navigation;
   navigationRules?: ResolvedNavigationRule[];
-  plugins?: ZudokuPlugin[];
+  plugins?: ApitogoPlugin[];
   slots?: Record<string, SlotType>;
   /**
    * @deprecated Use `slots` instead
@@ -151,7 +151,7 @@ export class ZudokuContext {
   public readonly env: Record<string, string | undefined>;
   public readonly protectedRoutes: ReturnType<typeof normalizeProtectedRoutes>;
   private readonly plugins: NonNullable<ZudokuContextOptions["plugins"]>;
-  private readonly emitter = createNanoEvents<ZudokuEvents>();
+  private readonly emitter = createNanoEvents<ApitogoEvents>();
   readonly initialize: Promise<void> | undefined;
 
   constructor(
@@ -218,16 +218,16 @@ export class ZudokuContext {
     return keys.flat();
   };
 
-  addEventListener<E extends keyof ZudokuEvents>(
+  addEventListener<E extends keyof ApitogoEvents>(
     event: E,
-    callback: ZudokuEvents[E],
+    callback: ApitogoEvents[E],
   ) {
     return this.emitter.on(event, callback);
   }
 
-  emitEvent = <E extends keyof ZudokuEvents>(
+  emitEvent = <E extends keyof ApitogoEvents>(
     event: E,
-    ...data: Parameters<ZudokuEvents[E]>
+    ...data: Parameters<ApitogoEvents[E]>
   ) => {
     return this.emitter.emit(event, ...data);
   };

package/src/lib/core/plugins.ts

@@ -8,12 +8,12 @@ import type { AuthenticationPlugin } from "../authentication/authentication.js";
 import type { MdxComponentsType } from "../util/MdxComponents.js";
 import type {
   ApiIdentity,
+  ApitogoEvents,
   ZudokuContext,
-  ZudokuEvents,
 } from "./ZudokuContext.js";
 export { runPluginTransformConfig } from "./transform-config.js";
 
-export type ZudokuPlugin =
+export type ApitogoPlugin =
   | CommonPlugin
   | ProfileMenuPlugin
   | NavigationPlugin
@@ -89,50 +89,50 @@ export interface CommonPlugin {
   getMdxComponents?: () => MdxComponentsType;
 }
 
-export type EventConsumerPlugin<Event extends ZudokuEvents = ZudokuEvents> = {
+export type EventConsumerPlugin<Event extends ApitogoEvents = ApitogoEvents> = {
   events: { [K in keyof Event]?: Event[K] };
 };
 
 export const isEventConsumerPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is EventConsumerPlugin =>
   "events" in obj && typeof obj.events === "object";
 
 export const isProfileMenuPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is ProfileMenuPlugin =>
   "getProfileMenuItems" in obj && typeof obj.getProfileMenuItems === "function";
 
 export const isNavigationPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is NavigationPlugin =>
   "getRoutes" in obj && typeof obj.getRoutes === "function";
 
 export const isAuthenticationPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is AuthenticationPlugin =>
   "signUp" in obj && typeof obj.signUp === "function";
 
 export const isSearchPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is SearchProviderPlugin =>
   "renderSearch" in obj && typeof obj.renderSearch === "function";
 
-export const needsInitialization = (obj: ZudokuPlugin): obj is CommonPlugin =>
+export const needsInitialization = (obj: ApitogoPlugin): obj is CommonPlugin =>
   "initialize" in obj && typeof obj.initialize === "function";
 
-export const hasHead = (obj: ZudokuPlugin): obj is CommonPlugin =>
+export const hasHead = (obj: ApitogoPlugin): obj is CommonPlugin =>
   "getHead" in obj && typeof obj.getHead === "function";
 
-export const isMdxProviderPlugin = (obj: ZudokuPlugin): obj is CommonPlugin =>
+export const isMdxProviderPlugin = (obj: ApitogoPlugin): obj is CommonPlugin =>
   "getMdxComponents" in obj && typeof obj.getMdxComponents === "function";
 
 export const isApiIdentityPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is ApiIdentityPlugin =>
   "getIdentities" in obj && typeof obj.getIdentities === "function";
 
 export const isTransformConfigPlugin = (
-  obj: ZudokuPlugin,
+  obj: ApitogoPlugin,
 ): obj is TransformConfigPlugin =>
   "transformConfig" in obj && typeof obj.transformConfig === "function";

package/src/lib/hooks/index.ts

@@ -6,6 +6,8 @@ export {
   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";

package/src/lib/hooks/useEvent.ts

@@ -1,41 +1,41 @@
 import { useEffect, useState } from "react";
-import { useZudoku } from "../components/context/ZudokuContext.js";
-import type { ZudokuEvents } from "../core/ZudokuContext.js";
+import { useApitogo } from "../components/context/ZudokuContext.js";
+import type { ApitogoEvents } from "../core/ZudokuContext.js";
 
-type EventParameters<Event extends keyof ZudokuEvents> = Parameters<
-  ZudokuEvents[Event]
+type EventParameters<Event extends keyof ApitogoEvents> = Parameters<
+  ApitogoEvents[Event]
 >;
 
 /**
- * Hook to subscribe to Zudoku events with automatic cleanup
+ * Hook to subscribe to APIToGo application events with automatic cleanup
  * @param event The event to subscribe to
  * @param callback Optional callback to be called when the event is emitted
  * @returns The latest event data if no callback is provided, or the callback's return value if it returns something
  */
-export function useEvent<E extends keyof ZudokuEvents>(
+export function useEvent<E extends keyof ApitogoEvents>(
   event: E,
 ): EventParameters<E>;
-export function useEvent<E extends keyof ZudokuEvents, R>(
+export function useEvent<E extends keyof ApitogoEvents, R>(
   event: E,
   callback: (...args: EventParameters<E>) => R,
 ): R;
-export function useEvent<E extends keyof ZudokuEvents, R>(
+export function useEvent<E extends keyof ApitogoEvents, R>(
   event: E,
   callback?: (...args: EventParameters<E>) => R,
 ) {
-  const zudoku = useZudoku();
+  const apitogo = useApitogo();
   const [latestData, setLatestData] = useState<R | EventParameters<E>>();
 
   useEffect(() => {
-    return zudoku.addEventListener(event, ((...args: EventParameters<E>) => {
+    return apitogo.addEventListener(event, ((...args: EventParameters<E>) => {
       if (callback) {
         const result = callback(...args);
         setLatestData(result);
       } else {
         setLatestData(args);
       }
-    }) as ZudokuEvents[E]);
-  }, [zudoku, event, callback]);
+    }) as ApitogoEvents[E]);
+  }, [apitogo, event, callback]);
 
   return latestData;
 }

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

@@ -1,7 +1,7 @@
 import { matchPath } from "react-router";
 import type { NavigationItem } from "../../../config/validators/NavigationSchema.js";
 import type { AuthState } from "../../authentication/state.js";
-import type { ZudokuPlugin } from "../../core/plugins.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
 import { joinUrl } from "../../util/joinUrl.js";
 import { slugify } from "../../util/slugify.js";
 
@@ -49,7 +49,7 @@ export const apiCatalogPlugin = ({
   categories?: CatalogCategory[];
   items: ApiCatalogItem[];
   filterCatalogItems?: FilterCatalogItemsFn;
-}): ZudokuPlugin => {
+}): ApitogoPlugin => {
   const paths = Object.fromEntries(
     categories.flatMap((category) =>
       [undefined, ...category.tags].map((tag) => [

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

@@ -5,7 +5,7 @@ import type { UseAuthReturn } from "../../authentication/hook.js";
 import type {
   ApiIdentityPlugin,
   ProfileMenuPlugin,
-  ZudokuPlugin,
+  ApitogoPlugin,
 } from "../../core/plugins.js";
 import type { ZudokuContext } from "../../core/ZudokuContext.js";
 import invariant from "../../util/invariant.js";
@@ -203,7 +203,7 @@ export const apiKeyPlugin = ({
   isZuplo,
   ...options
 }: Omit<ApiKeysOptions, "enabled"> &
-  InternalApiKeyPluginOptions): ZudokuPlugin &
+  InternalApiKeyPluginOptions): ApitogoPlugin &
   ApiIdentityPlugin &
   ProfileMenuPlugin => {
   if (isZuplo && !deploymentName) {

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

@@ -2,7 +2,7 @@ import type { MDXProps } from "mdx/types.js";
 import type { JSX } from "react";
 import type { ZudokuDocsConfig } from "../../../config/validators/ZudokuConfig.js";
 import type { Toc } from "../../../vite/mdx/rehype-extract-toc-with-jsx.js";
-import type { ZudokuPlugin } from "../../core/plugins.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
 
 export interface MarkdownPluginOptions extends ZudokuDocsConfig {
   basePath: string;
@@ -37,7 +37,7 @@ export type MDXImport = {
 
 export const markdownPlugin = (
   options: MarkdownPluginOptions,
-): ZudokuPlugin => ({
+): ApitogoPlugin => ({
   getRoutes: () => {
     return Object.entries(options.fileImports).map(
       ([routePath, importPromise]) => ({

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

@@ -1,4 +1,4 @@
-import { useZudoku } from "@lukoweb/apitogo/hooks";
+import { useApitogo } from "@lukoweb/apitogo/hooks";
 import { Badge } from "@lukoweb/apitogo/ui/Badge.js";
 import {
   NativeSelect,
@@ -63,7 +63,7 @@ export const Sidecar = ({
 }) => {
   const { options } = useOasConfig();
   const auth = useAuthState();
-  const context = useZudoku();
+  const context = useApitogo();
 
   const methodTextColor = methodForColor(operation.method);
 
@@ -175,8 +175,10 @@ export const Sidecar = ({
   const showPlayground =
     isOnScreen &&
     (operation.extensions["x-explorer-enabled"] === true ||
+      operation.extensions["x-apitogo-playground-enabled"] === true ||
       operation.extensions["x-zudoku-playground-enabled"] === true ||
       (operation.extensions["x-explorer-enabled"] === undefined &&
+        operation.extensions["x-apitogo-playground-enabled"] === undefined &&
         operation.extensions["x-zudoku-playground-enabled"] === undefined &&
         !options?.disablePlayground));
 

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

@@ -1,7 +1,7 @@
 import { CirclePlayIcon } from "lucide-react";
 import { type PropsWithChildren, Suspense, lazy } from "react";
 import { matchPath } from "react-router";
-import type { ZudokuPlugin } from "../../core/plugins.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
 import { Button } from "../../ui/Button.js";
 import { joinUrl } from "../../util/joinUrl.js";
 import { GraphQLClient } from "./client/GraphQLClient.js";
@@ -52,7 +52,7 @@ export type OpenApiPluginOptions = OasPluginConfig;
 
 export const UNTAGGED_PATH = "~endpoints";
 
-export const openApiPlugin = (config: OasPluginConfig): ZudokuPlugin => {
+export const openApiPlugin = (config: OasPluginConfig): ApitogoPlugin => {
   const basePath = joinUrl(config.path);
   const client = new GraphQLClient(config);
 
@@ -148,10 +148,13 @@ export const openApiPlugin = (config: OasPluginConfig): ZudokuPlugin => {
               const categoryPath = joinUrl(basePath, versionParam, tag.slug);
 
               const isCollapsed =
+                tag.extensions?.["x-apitogo-collapsed"] ??
                 tag.extensions?.["x-zudoku-collapsed"] ??
                 !config.options?.expandAllTags;
               const isCollapsible =
-                tag.extensions?.["x-zudoku-collapsible"] ?? true;
+                tag.extensions?.["x-apitogo-collapsible"] ??
+                tag.extensions?.["x-zudoku-collapsible"] ??
+                true;
 
               return [
                 tag.name,

package/src/lib/plugins/search-inkeep/index.tsx

@@ -6,7 +6,7 @@ import type {
 } from "@inkeep/cxkit-types";
 import { useEffect, useMemo, useState } from "react";
 import { ClientOnly } from "../../components/ClientOnly.js";
-import type { ZudokuPlugin } from "../../core/plugins.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
 import {
   aiChatSettings,
   baseSettings,
@@ -86,7 +86,7 @@ const InkeepSearch = ({
 
 export const inkeepSearchPlugin = (
   settings: InkeepBaseSettings,
-): ZudokuPlugin => {
+): ApitogoPlugin => {
   return {
     getHead: () => {
       return (

package/src/lib/plugins/search-pagefind/index.tsx

@@ -1,6 +1,6 @@
 import type { ZudokuConfig } from "../../../config/validators/ZudokuConfig.js";
 import { ClientOnly } from "../../components/ClientOnly.js";
-import type { ZudokuPlugin } from "../../core/plugins.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
 import { PagefindSearch } from "./PagefindSearch.js";
 
 export type PagefindOptions = Extract<
@@ -10,7 +10,7 @@ export type PagefindOptions = Extract<
 
 export const pagefindSearchPlugin = (
   options: PagefindOptions,
-): ZudokuPlugin => {
+): ApitogoPlugin => {
   return {
     renderSearch: ({ isOpen, onClose }) => (
       <ClientOnly>

package/src/lib/testing/index.tsx

@@ -23,7 +23,10 @@ type QueryData = {
   data: unknown;
 };
 
-type StaticZudokuProps = ZudokuContextOptions & {
+/**
+ * @deprecated Use {@link StaticApitogoProps} instead.
+ */
+export type StaticZudokuProps = ZudokuContextOptions & {
   path: string;
   queryData?: QueryData[];
   env?: Record<string, string>;
@@ -31,6 +34,9 @@ type StaticZudokuProps = ZudokuContextOptions & {
   redirects?: ZudokuRedirect[];
 };
 
+/** Prefer this over {@link StaticZudokuProps}. */
+export type StaticApitogoProps = StaticZudokuProps;
+
 const getRoutesByOptions = (options: ZudokuContextOptions) => {
   return [
     ...(options.plugins ?? []),
@@ -134,4 +140,7 @@ const StaticZudoku = ({
   );
 };
 
-export { StaticZudoku, type StaticZudokuProps, type QueryData };
+/**
+ * @deprecated Use {@link StaticApitogo} and {@link StaticApitogoProps} instead.
+ */
+export { StaticZudoku, StaticZudoku as StaticApitogo, type QueryData };

package/src/lib/util/invariant.ts

@@ -7,7 +7,7 @@ export default function invariant(
    * the message takes a fair amount of effort to compute
    */
   message?: string | (() => string),
-  options?: ZudokuErrorOptions,
+  options?: ApitogoErrorOptions,
 ): asserts condition {
   if (condition) {
     return;
@@ -17,26 +17,36 @@ export default function invariant(
   const provided: string | undefined =
     typeof message === "function" ? message() : message;
 
-  throw new ZudokuError(provided ?? "Invariant failed", options);
+  throw new ApitogoError(provided ?? "Invariant failed", options);
 }
 
-export type ZudokuErrorOptions = {
+export type ApitogoErrorOptions = {
   developerHint?: string;
   title?: string;
   cause?: Error;
 };
 
-export class ZudokuError extends Error {
+/**
+ * @deprecated Use {@link ApitogoErrorOptions} instead.
+ */
+export type ZudokuErrorOptions = ApitogoErrorOptions;
+
+export class ApitogoError extends Error {
   public developerHint: string | undefined;
   public title: string | undefined;
 
   constructor(
     message: string,
-    { developerHint, title, cause }: ZudokuErrorOptions = {},
+    { developerHint, title, cause }: ApitogoErrorOptions = {},
   ) {
     super(message, { cause });
-    this.name = "ZudokuError";
+    this.name = "ApitogoError";
     this.title = title;
     this.developerHint = developerHint;
   }
 }
+
+/**
+ * @deprecated Use {@link ApitogoError} instead.
+ */
+export const ZudokuError = ApitogoError;

package/src/types.d.ts

@@ -1,6 +1,6 @@
 declare module "virtual:zudoku-docs-plugin" {
   export const configuredDocsPlugin:
-    | import("./lib/core/plugins.ts").ZudokuPlugin
+    | import("./lib/core/plugins.ts").ApitogoPlugin
     | undefined;
   /**
    * Map of markdown files and imports
@@ -15,25 +15,25 @@ declare module "virtual:zudoku-navigation" {
 }
 
 declare module "virtual:zudoku-api-plugins" {
-  export const configuredApiPlugins: import("./lib/core/plugins.ts").ZudokuPlugin[];
-  export const configuredApiCatalogPlugins: import("./lib/core/plugins.ts").ZudokuPlugin[];
+  export const configuredApiPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
+  export const configuredApiCatalogPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
 }
 
 declare module "virtual:zudoku-search-plugin" {
   export const configuredSearchPlugin:
-    | import("./lib/core/plugins.ts").ZudokuPlugin
+    | import("./lib/core/plugins.ts").ApitogoPlugin
     | undefined;
 }
 
 declare module "virtual:zudoku-api-keys-plugin" {
   export const configuredApiKeysPlugin:
-    | import("./lib/core/plugins.ts").ZudokuPlugin
+    | import("./lib/core/plugins.ts").ApitogoPlugin
     | undefined;
 }
 
 declare module "virtual:zudoku-custom-pages-plugin" {
   export const configuredCustomPagesPlugin:
-    | import("./lib/core/plugins.ts").ZudokuPlugin
+    | import("./lib/core/plugins.ts").ApitogoPlugin
     | undefined;
 }
 

package/src/vite/config.ts

@@ -15,10 +15,22 @@ import { getZudokuRootDir } from "../cli/common/package-json.js";
 import { loadZudokuConfig } from "../config/loader.js";
 import { CdnUrlSchema } from "../config/validators/ZudokuConfig.js";
 import { joinUrl } from "../lib/util/joinUrl.js";
+import { ensurePagefindDevStub } from "./pagefind-dev-stub.js";
 import { findPackageRoot } from "./package-root.js";
 import vitePlugin from "./plugin.js";
 import { getZuploSystemConfigurations } from "./zuplo.js";
 
+/** Resolved absolute public directory (Vite default: `<root>/public`). */
+const resolveMergedPublicDir = (
+  rootDir: string,
+  merged: InlineConfig,
+): string | undefined => {
+  if (merged.publicDir === false) return undefined;
+  const rel =
+    typeof merged.publicDir === "string" ? merged.publicDir : "public";
+  return path.resolve(rootDir, rel);
+};
+
 export type ZudokuConfigEnv = ConfigEnv & {
   mode: "development" | "production";
 };
@@ -230,5 +242,17 @@ export async function getViteConfig(
     }
   }
 
+  // Create pagefind stub before Vite starts. In development, `optimizeDeps.entries` crawls all of
+  // `src/lib/**`, which includes PagefindSearch's dev import of `/pagefind/pagefind.js`; esbuild
+  // must be able to open that path even when search is not configured. Pagefind users still get
+  // the stub until a real index is written (dev index or production prerender).
+  const publicDir = resolveMergedPublicDir(dir, mergedViteConfig);
+  if (
+    publicDir &&
+    (configEnv.mode === "development" || config.search?.type === "pagefind")
+  ) {
+    await ensurePagefindDevStub(publicDir);
+  }
+
   return mergedViteConfig;
 }