@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/lib/plugins/search-pagefind/types.ts

@@ -1,118 +1,118 @@
-interface PagefindIndexOptions {
-  basePath?: string;
-  baseUrl?: string;
-  excerptLength?: number;
-  indexWeight?: number;
-  mergeFilter?: Record<string, unknown>;
-  highlightParam?: string;
-  language?: string;
-  primary?: boolean;
-  ranking?: PagefindRankingWeights;
-}
-
-interface PagefindRankingWeights {
-  termSimilarity?: number;
-  pageLength?: number;
-  termSaturation?: number;
-  termFrequency?: number;
-}
-
-interface PagefindSearchOptions {
-  preload?: boolean;
-  verbose?: boolean;
-  filters?: Record<string, unknown>;
-  sort?: Record<string, unknown>;
-}
-
-type PagefindFilterCounts = Record<string, Record<string, number>> & {};
-
-interface PagefindSearchResults {
-  results: PagefindSearchResult[];
-  unfilteredResultCount: number;
-  filters: PagefindFilterCounts;
-  totalFilters: PagefindFilterCounts;
-  timings: {
-    preload: number;
-    search: number;
-    total: number;
-  };
-}
-
-interface PagefindSearchResult {
-  id: string;
-  score: number;
-  words: number[];
-  data: () => Promise<PagefindSearchFragment>;
-}
-
-interface PagefindSearchFragment {
-  url: string;
-  raw_url?: string;
-  content: string;
-  raw_content?: string;
-  excerpt: string;
-  sub_results: PagefindSubResult[];
-  word_count: number;
-  locations: number[];
-  weighted_locations: PagefindWordLocation[];
-  filters: Record<string, string[]>;
-  meta: Record<string, string>;
-  anchors: PagefindSearchAnchor[];
-}
-
-interface PagefindSubResult {
-  title: string;
-  url: string;
-  locations: number[];
-  weighted_locations: PagefindWordLocation[];
-  excerpt: string;
-  anchor?: PagefindSearchAnchor;
-}
-
-interface PagefindWordLocation {
-  weight: number;
-  balanced_score: number;
-  location: number;
-}
-
-interface PagefindSearchAnchor {
-  element: string;
-  id: string;
-  text?: string;
-  location: number;
-}
-
-interface Pagefind {
-  debouncedSearch: (
-    query: string,
-    options?: PagefindSearchOptions,
-    duration?: number,
-  ) => Promise<PagefindSearchResults>;
-  destroy: () => Promise<void>;
-  filters: () => Promise<PagefindFilterCounts>;
-  init: () => Promise<void>;
-  mergeIndex: (
-    indexPath: string,
-    options?: Record<string, unknown>,
-  ) => Promise<void>;
-  options: (options: PagefindIndexOptions) => Promise<void>;
-  preload: (term: string, options?: PagefindIndexOptions) => Promise<void>;
-  search: (
-    term: string,
-    options?: PagefindSearchOptions,
-  ) => Promise<PagefindSearchResults>;
-}
-
-export type {
-  Pagefind,
-  PagefindFilterCounts,
-  PagefindIndexOptions,
-  PagefindRankingWeights,
-  PagefindSearchAnchor,
-  PagefindSearchFragment,
-  PagefindSearchOptions,
-  PagefindSearchResult,
-  PagefindSearchResults,
-  PagefindSubResult,
-  PagefindWordLocation,
-};
+interface PagefindIndexOptions {
+  basePath?: string;
+  baseUrl?: string;
+  excerptLength?: number;
+  indexWeight?: number;
+  mergeFilter?: Record<string, unknown>;
+  highlightParam?: string;
+  language?: string;
+  primary?: boolean;
+  ranking?: PagefindRankingWeights;
+}
+
+interface PagefindRankingWeights {
+  termSimilarity?: number;
+  pageLength?: number;
+  termSaturation?: number;
+  termFrequency?: number;
+}
+
+interface PagefindSearchOptions {
+  preload?: boolean;
+  verbose?: boolean;
+  filters?: Record<string, unknown>;
+  sort?: Record<string, unknown>;
+}
+
+type PagefindFilterCounts = Record<string, Record<string, number>> & {};
+
+interface PagefindSearchResults {
+  results: PagefindSearchResult[];
+  unfilteredResultCount: number;
+  filters: PagefindFilterCounts;
+  totalFilters: PagefindFilterCounts;
+  timings: {
+    preload: number;
+    search: number;
+    total: number;
+  };
+}
+
+interface PagefindSearchResult {
+  id: string;
+  score: number;
+  words: number[];
+  data: () => Promise<PagefindSearchFragment>;
+}
+
+interface PagefindSearchFragment {
+  url: string;
+  raw_url?: string;
+  content: string;
+  raw_content?: string;
+  excerpt: string;
+  sub_results: PagefindSubResult[];
+  word_count: number;
+  locations: number[];
+  weighted_locations: PagefindWordLocation[];
+  filters: Record<string, string[]>;
+  meta: Record<string, string>;
+  anchors: PagefindSearchAnchor[];
+}
+
+interface PagefindSubResult {
+  title: string;
+  url: string;
+  locations: number[];
+  weighted_locations: PagefindWordLocation[];
+  excerpt: string;
+  anchor?: PagefindSearchAnchor;
+}
+
+interface PagefindWordLocation {
+  weight: number;
+  balanced_score: number;
+  location: number;
+}
+
+interface PagefindSearchAnchor {
+  element: string;
+  id: string;
+  text?: string;
+  location: number;
+}
+
+interface Pagefind {
+  debouncedSearch: (
+    query: string,
+    options?: PagefindSearchOptions,
+    duration?: number,
+  ) => Promise<PagefindSearchResults>;
+  destroy: () => Promise<void>;
+  filters: () => Promise<PagefindFilterCounts>;
+  init: () => Promise<void>;
+  mergeIndex: (
+    indexPath: string,
+    options?: Record<string, unknown>,
+  ) => Promise<void>;
+  options: (options: PagefindIndexOptions) => Promise<void>;
+  preload: (term: string, options?: PagefindIndexOptions) => Promise<void>;
+  search: (
+    term: string,
+    options?: PagefindSearchOptions,
+  ) => Promise<PagefindSearchResults>;
+}
+
+export type {
+  Pagefind,
+  PagefindFilterCounts,
+  PagefindIndexOptions,
+  PagefindRankingWeights,
+  PagefindSearchAnchor,
+  PagefindSearchFragment,
+  PagefindSearchOptions,
+  PagefindSearchResult,
+  PagefindSearchResults,
+  PagefindSubResult,
+  PagefindWordLocation,
+};

package/src/lib/shiki-constants.ts

@@ -1,24 +1,24 @@
-import type { BundledLanguage } from "shiki";
-
-export const HIGHLIGHT_CODE_BLOCK_CLASS =
-  "overflow-x-auto scrollbar not-inline";
-
-export const defaultLanguages: BundledLanguage[] = [
-  "shellscript",
-  "javascript",
-  "jsx",
-  "typescript",
-  "tsx",
-  "json",
-  "jsonc",
-  "yaml",
-  "python",
-  "java",
-  "go",
-  "graphql",
-  "html",
-  "css",
-  "xml",
-  "markdown",
-  "mdx",
-];
+import type { BundledLanguage } from "shiki";
+
+export const HIGHLIGHT_CODE_BLOCK_CLASS =
+  "overflow-x-auto scrollbar not-inline";
+
+export const defaultLanguages: BundledLanguage[] = [
+  "shellscript",
+  "javascript",
+  "jsx",
+  "typescript",
+  "tsx",
+  "json",
+  "jsonc",
+  "yaml",
+  "python",
+  "java",
+  "go",
+  "graphql",
+  "html",
+  "css",
+  "xml",
+  "markdown",
+  "mdx",
+];

package/src/lib/testing/index.tsx

@@ -1,146 +1,146 @@
-import {
-  QueryClient,
-  QueryClientProvider,
-  type QueryKey,
-} from "@tanstack/react-query";
-import { HelmetProvider } from "@zudoku/react-helmet-async";
-import { createMemoryRouter, Outlet, RouterProvider } from "react-router";
-import { createRedirectRoutes } from "../../app/utils/createRedirectRoutes.js";
-import type { ZudokuRedirect } from "../../config/validators/ZudokuConfig.js";
-import type { AuthenticationPlugin } from "../authentication/authentication.js";
-import { useAuthState } from "../authentication/state.js";
-import { RenderContext } from "../components/context/RenderContext.js";
-import { Layout } from "../components/Layout.js";
-import { Meta } from "../components/Meta.js";
-import { Zudoku } from "../components/Zudoku.js";
-import { isNavigationPlugin, type RouteObject } from "../core/plugins.js";
-import { RouteGuard } from "../core/RouteGuard.js";
-import type { ZudokuContextOptions } from "../core/ZudokuContext.js";
-import { RouterError } from "../errors/RouterError.js";
-
-type QueryData = {
-  queryKey: QueryKey;
-  data: unknown;
-};
-
-/**
- * @deprecated Use {@link StaticApitogoProps} instead.
- */
-export type StaticZudokuProps = ZudokuContextOptions & {
-  path: string;
-  queryData?: QueryData[];
-  env?: Record<string, string>;
-  isAuthenticated?: boolean;
-  redirects?: ZudokuRedirect[];
-};
-
-/** Prefer this over {@link StaticZudokuProps}. */
-export type StaticApitogoProps = StaticZudokuProps;
-
-const getRoutesByOptions = (options: ZudokuContextOptions) => {
-  return [
-    ...(options.plugins ?? []),
-    ...(options.authentication ? [options.authentication] : []),
-  ].flatMap((plugin) => (isNavigationPlugin(plugin) ? plugin.getRoutes() : []));
-};
-
-const wrapWithLayout = (route: RouteObject) => ({
-  element: <Layout />,
-  children: [route],
-});
-
-const noopAuth: AuthenticationPlugin = {
-  signIn: async () => {},
-  signOut: async () => {},
-  signUp: async () => {},
-  signRequest: async (req) => req,
-};
-
-const StaticZudoku = ({
-  path,
-  queryData,
-  env = {},
-  isAuthenticated,
-  redirects,
-  ...options
-}: StaticZudokuProps) => {
-  if (isAuthenticated) {
-    useAuthState.setState({
-      isAuthenticated: true,
-      isPending: false,
-      profile: {
-        sub: "test-user",
-        email: "test@example.com",
-        emailVerified: true,
-        name: "Test User",
-        pictureUrl: undefined,
-      },
-      providerData: null,
-    });
-
-    options.plugins = [...(options.plugins ?? []), noopAuth];
-  }
-
-  const queryClient = new QueryClient({
-    defaultOptions: {
-      queries: {
-        staleTime: 1000 * 60 * 5,
-        retry: false,
-        // Ensure un-mocked queries fail immediately instead of hanging
-        queryFn: () => {
-          throw new Error("No queryData provided for this query key");
-        },
-      },
-    },
-  });
-
-  queryClient.setQueryData(["zudoku-initialize", "no-dehydrate"], true);
-
-  for (const { queryKey, data } of queryData ?? []) {
-    queryClient.setQueryData(queryKey, data);
-  }
-
-  const routes = getRoutesByOptions(options);
-  const router = createMemoryRouter(
-    [
-      ...createRedirectRoutes(redirects),
-      {
-        element: (
-          <Zudoku {...options} env={env}>
-            <Outlet />
-          </Zudoku>
-        ),
-        hydrateFallbackElement: <div>Loading...</div>,
-        children: [
-          {
-            element: (
-              <Meta>
-                <RouteGuard />
-              </Meta>
-            ),
-            errorElement: <RouterError />,
-            children: routes.map((r) =>
-              r.handle?.layout === "none" ? r : wrapWithLayout(r),
-            ),
-          },
-        ],
-      },
-    ],
-    { initialEntries: [path] },
-  );
-
-  return (
-    <QueryClientProvider client={queryClient}>
-      <HelmetProvider>
-        <RenderContext value={{ status: 200, bypassProtection: false }}>
-          <RouterProvider router={router} />
-        </RenderContext>
-      </HelmetProvider>
-    </QueryClientProvider>
-  );
-};
-
-/**
- * @deprecated Use {@link StaticApitogo} and {@link StaticApitogoProps} instead.
- */
-export { StaticZudoku, StaticZudoku as StaticApitogo, type QueryData };
+import {
+  QueryClient,
+  QueryClientProvider,
+  type QueryKey,
+} from "@tanstack/react-query";
+import { HelmetProvider } from "@zudoku/react-helmet-async";
+import { createMemoryRouter, Outlet, RouterProvider } from "react-router";
+import { createRedirectRoutes } from "../../app/utils/createRedirectRoutes.js";
+import type { ZudokuRedirect } from "../../config/validators/ZudokuConfig.js";
+import type { AuthenticationPlugin } from "../authentication/authentication.js";
+import { useAuthState } from "../authentication/state.js";
+import { RenderContext } from "../components/context/RenderContext.js";
+import { Layout } from "../components/Layout.js";
+import { Meta } from "../components/Meta.js";
+import { Zudoku } from "../components/Zudoku.js";
+import { isNavigationPlugin, type RouteObject } from "../core/plugins.js";
+import { RouteGuard } from "../core/RouteGuard.js";
+import type { ZudokuContextOptions } from "../core/ZudokuContext.js";
+import { RouterError } from "../errors/RouterError.js";
+
+type QueryData = {
+  queryKey: QueryKey;
+  data: unknown;
+};
+
+/**
+ * @deprecated Use {@link StaticApitogoProps} instead.
+ */
+export type StaticZudokuProps = ZudokuContextOptions & {
+  path: string;
+  queryData?: QueryData[];
+  env?: Record<string, string>;
+  isAuthenticated?: boolean;
+  redirects?: ZudokuRedirect[];
+};
+
+/** Prefer this over {@link StaticZudokuProps}. */
+export type StaticApitogoProps = StaticZudokuProps;
+
+const getRoutesByOptions = (options: ZudokuContextOptions) => {
+  return [
+    ...(options.plugins ?? []),
+    ...(options.authentication ? [options.authentication] : []),
+  ].flatMap((plugin) => (isNavigationPlugin(plugin) ? plugin.getRoutes() : []));
+};
+
+const wrapWithLayout = (route: RouteObject) => ({
+  element: <Layout />,
+  children: [route],
+});
+
+const noopAuth: AuthenticationPlugin = {
+  signIn: async () => {},
+  signOut: async () => {},
+  signUp: async () => {},
+  signRequest: async (req) => req,
+};
+
+const StaticZudoku = ({
+  path,
+  queryData,
+  env = {},
+  isAuthenticated,
+  redirects,
+  ...options
+}: StaticZudokuProps) => {
+  if (isAuthenticated) {
+    useAuthState.setState({
+      isAuthenticated: true,
+      isPending: false,
+      profile: {
+        sub: "test-user",
+        email: "test@example.com",
+        emailVerified: true,
+        name: "Test User",
+        pictureUrl: undefined,
+      },
+      providerData: null,
+    });
+
+    options.plugins = [...(options.plugins ?? []), noopAuth];
+  }
+
+  const queryClient = new QueryClient({
+    defaultOptions: {
+      queries: {
+        staleTime: 1000 * 60 * 5,
+        retry: false,
+        // Ensure un-mocked queries fail immediately instead of hanging
+        queryFn: () => {
+          throw new Error("No queryData provided for this query key");
+        },
+      },
+    },
+  });
+
+  queryClient.setQueryData(["zudoku-initialize", "no-dehydrate"], true);
+
+  for (const { queryKey, data } of queryData ?? []) {
+    queryClient.setQueryData(queryKey, data);
+  }
+
+  const routes = getRoutesByOptions(options);
+  const router = createMemoryRouter(
+    [
+      ...createRedirectRoutes(redirects),
+      {
+        element: (
+          <Zudoku {...options} env={env}>
+            <Outlet />
+          </Zudoku>
+        ),
+        hydrateFallbackElement: <div>Loading...</div>,
+        children: [
+          {
+            element: (
+              <Meta>
+                <RouteGuard />
+              </Meta>
+            ),
+            errorElement: <RouterError />,
+            children: routes.map((r) =>
+              r.handle?.layout === "none" ? r : wrapWithLayout(r),
+            ),
+          },
+        ],
+      },
+    ],
+    { initialEntries: [path] },
+  );
+
+  return (
+    <QueryClientProvider client={queryClient}>
+      <HelmetProvider>
+        <RenderContext value={{ status: 200, bypassProtection: false }}>
+          <RouterProvider router={router} />
+        </RenderContext>
+      </HelmetProvider>
+    </QueryClientProvider>
+  );
+};
+
+/**
+ * @deprecated Use {@link StaticApitogo} and {@link StaticApitogoProps} instead.
+ */
+export { StaticZudoku, StaticZudoku as StaticApitogo, type QueryData };