zudoku 0.0.0-fcb84d6 → 0.0.0-fdfe742

package/lib/zudoku.plugin-search-pagefind.js

@@ -0,0 +1,230 @@
+import { j as e } from "./jsx-runtime-C5mzlN2N.js";
+import { C as k } from "./ClientOnly-E7hGysn1.js";
+import { VisuallyHidden as v } from "@radix-ui/react-visually-hidden";
+import { u as N, k as y, l as j, o as _, j as L } from "./hook-k7PfUIsj.js";
+import { useRef as S, useLayoutEffect as T, useState as w } from "react";
+import { B as E } from "./Button-BE9IVkWV.js";
+import { C as R, a as f, b as p, c as F, d as I, e as q, f as P } from "./Callout-CvY02DXU.js";
+import { c as $ } from "./Dialog-B53OMCvW.js";
+import { S as A } from "./RouteGuard-DiCUImwp.js";
+import { BracketsIcon as D, FileTextIcon as O } from "lucide-react";
+import { a as B, L as g } from "./chunk-DQRVZFIR-BblmKnHy.js";
+const U = async ({
+  search: r,
+  options: a,
+  auth: n,
+  context: i
+}) => {
+  const o = a.maxResults ?? 10, s = a.transformResults ?? (() => !0), t = [], c = z({
+    search: r,
+    transformFn: s,
+    auth: n,
+    context: i
+  });
+  for await (const l of c)
+    if (t.push(l), t.length >= o) break;
+  return t;
+};
+async function* z({
+  search: r,
+  transformFn: a,
+  auth: n,
+  context: i
+}) {
+  let s = 0;
+  for (; s < r.results.length; ) {
+    const t = r.results.slice(
+      s,
+      s + 5
+    );
+    s += t.length;
+    const c = await Promise.all(t.map((l) => l.data()));
+    for (const l of c) {
+      const d = a({ result: l, auth: n, context: i });
+      d !== !1 && (d === !0 || d == null ? yield l : yield d);
+    }
+  }
+}
+const G = (r, a) => {
+  const n = r.weighted_locations.reduce(
+    (o, s) => o + s.balanced_score,
+    0
+  );
+  return a.weighted_locations.reduce(
+    (o, s) => o + s.balanced_score,
+    0
+  ) - n;
+}, x = "cursor-pointer border border-transparent data-[selected=true]:border-border", H = ({
+  searchResults: r,
+  searchTerm: a,
+  onClose: n,
+  maxSubResults: i = 4
+}) => {
+  const o = B(), s = S(null);
+  return T(() => {
+    requestIdleCallback(() => {
+      s.current?.scrollTo({ top: 0 });
+    });
+  }, [a]), /* @__PURE__ */ e.jsxs(R, { className: "max-h-[450px]", ref: s, children: [
+    a && r.length > 0 && /* @__PURE__ */ e.jsx(
+      f,
+      {
+        className: "text-sm text-muted-foreground",
+        heading: `${r.length} results for "${a}"`
+      }
+    ),
+    a && r.map((t) => /* @__PURE__ */ e.jsxs(
+      f,
+      {
+        children: [
+          /* @__PURE__ */ e.jsx(
+            p,
+            {
+              asChild: !0,
+              value: `${t.meta.title}-${t.url}`,
+              className: x,
+              onSelect: () => {
+                o(t.url), n();
+              },
+              children: /* @__PURE__ */ e.jsxs(g, { to: t.url, children: [
+                t.meta.section === "openapi" ? /* @__PURE__ */ e.jsx(D, {}) : /* @__PURE__ */ e.jsx(O, {}),
+                t.meta.title
+              ] })
+            }
+          ),
+          t.sub_results.sort(G).slice(0, i).map((c) => /* @__PURE__ */ e.jsx(
+            p,
+            {
+              asChild: !0,
+              value: `sub-${t.meta.title}-${c.url}`,
+              className: x,
+              onSelect: () => {
+                o(c.url), n();
+              },
+              children: /* @__PURE__ */ e.jsx(g, { to: c.url, onClick: n, children: /* @__PURE__ */ e.jsxs("div", { className: "flex flex-col items-start gap-2 ms-2.5 ps-5 border-l border-muted-foreground/50", children: [
+                /* @__PURE__ */ e.jsx("span", { className: "font-bold", children: c.title }),
+                /* @__PURE__ */ e.jsx(
+                  "span",
+                  {
+                    className: "text-[13px] [&_mark]:bg-primary [&_mark]:text-primary-foreground",
+                    dangerouslySetInnerHTML: { __html: c.excerpt }
+                  }
+                )
+              ] }) })
+            },
+            `sub-${t.meta.title}-${c.url}`
+          ))
+        ]
+      },
+      [t.meta.title ?? t.excerpt, t.url].join("-")
+    ))
+  ] });
+}, m = {
+  // Slightly lower than default because API docs tend to have repetitive terms (parameter names, HTTP methods, etc.)
+  termFrequency: 0.8,
+  // Lower than default because API documentation pages tend to be longer due to comprehensive endpoint documentation
+  pageLength: 0.6,
+  // Slightly higher than default because in technical documentation, exact matches should be prioritized
+  termSimilarity: 1.2,
+  // Slightly lower than default because API docs might have legitimate repetition of terms
+  termSaturation: 1.2
+}, K = (r) => import(
+  /* @vite-ignore */
+  L(r, "/pagefind/pagefind.js")
+), V = (r) => {
+  const {
+    options: { basePath: a }
+  } = y(), { data: n, ...i } = j({
+    queryKey: ["pagefind", r.ranking],
+    retry: !1,
+    queryFn: async () => {
+      const o = await K(a);
+      return await o.init(), await o.options({
+        ranking: {
+          termFrequency: r.ranking?.termFrequency ?? m.termFrequency,
+          pageLength: r.ranking?.pageLength ?? m.pageLength,
+          termSimilarity: r.ranking?.termSimilarity ?? m.termSimilarity,
+          termSaturation: r.ranking?.termSaturation ?? m.termSaturation
+        }
+      }), o;
+    },
+    enabled: typeof window < "u"
+  });
+  return i.isError && i.error.message !== "NOT_BUILT_YET" && console.error(i.error), { ...i, pagefind: n };
+}, Y = ({
+  isOpen: r,
+  onClose: a,
+  options: n
+}) => {
+  const { pagefind: i, error: o, isError: s } = V(n), [t, c] = w(""), l = N(), d = y(), u = S(null), { data: b } = j({
+    queryKey: ["pagefind-search", t, l.isAuthenticated],
+    queryFn: async () => {
+      const C = l.isAuthenticated ? void 0 : { not: { section: A } }, h = await i?.search(t, { filters: C });
+      return h ? U({ search: h, options: n, auth: l, context: d }) : [];
+    },
+    placeholderData: _,
+    enabled: !!i && !!t
+  });
+  return /* @__PURE__ */ e.jsxs(
+    F,
+    {
+      command: { shouldFilter: !1 },
+      content: { className: "max-w-[750px]" },
+      open: r,
+      onOpenChange: a,
+      children: [
+        /* @__PURE__ */ e.jsx(v, { children: /* @__PURE__ */ e.jsx($, { children: "Search" }) }),
+        /* @__PURE__ */ e.jsx(
+          I,
+          {
+            ref: u,
+            placeholder: "Search...",
+            value: t,
+            onValueChange: c,
+            disabled: s
+          }
+        ),
+        /* @__PURE__ */ e.jsx(q, { children: t ? /* @__PURE__ */ e.jsxs("div", { className: "flex flex-col items-center", children: [
+          "No results found.",
+          /* @__PURE__ */ e.jsx(
+            E,
+            {
+              variant: "link",
+              onClick: () => {
+                c(""), u.current?.focus();
+              },
+              children: "Clear search"
+            }
+          )
+        ] }) : "Start typing to search" }),
+        s ? /* @__PURE__ */ e.jsx("div", { className: "p-4 text-sm", children: o.message === "NOT_BUILT_YET" ? /* @__PURE__ */ e.jsxs(P, { type: "info", children: [
+          "Search is currently not available in development mode by default.",
+          /* @__PURE__ */ e.jsx("br", {}),
+          "To still use search in development, run ",
+          /* @__PURE__ */ e.jsx("code", { children: "zudoku build" }),
+          " ",
+          "and copy the ",
+          /* @__PURE__ */ e.jsx("code", { children: "dist/pagefind" }),
+          " directory to your",
+          " ",
+          /* @__PURE__ */ e.jsx("code", { children: "public" }),
+          " directory."
+        ] }) : "An error occurred while loading search." }) : /* @__PURE__ */ e.jsx(
+          H,
+          {
+            searchResults: b ?? [],
+            searchTerm: t,
+            onClose: a,
+            maxSubResults: n.maxSubResults
+          }
+        )
+      ]
+    }
+  );
+}, se = (r) => ({
+  renderSearch: ({ isOpen: a, onClose: n }) => /* @__PURE__ */ e.jsx(k, { children: /* @__PURE__ */ e.jsx(Y, { isOpen: a, onClose: n, options: r }) })
+});
+export {
+  se as pagefindSearchPlugin
+};
+//# sourceMappingURL=zudoku.plugin-search-pagefind.js.map

package/lib/zudoku.plugin-search-pagefind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zudoku.plugin-search-pagefind.js","sources":["../src/lib/plugins/search-pagefind/get-results.tsx","../src/lib/plugins/search-pagefind/ResultList.tsx","../src/lib/plugins/search-pagefind/PagefindSearch.tsx","../src/lib/plugins/search-pagefind/index.tsx"],"sourcesContent":["import type { AuthState } from \"../../authentication/state.js\";\nimport type { ZudokuContext } from \"../../core/ZudokuContext.js\";\nimport type { PagefindOptions } from \"./index.js\";\nimport type { PagefindSearchFragment, PagefindSearchResults } from \"./types.js\";\n\nexport const getResults = async ({\n  search,\n  options,\n  auth,\n  context,\n}: {\n  search: PagefindSearchResults;\n  options: PagefindOptions;\n  auth: AuthState;\n  context: ZudokuContext;\n}) => {\n  const maxResults = options.maxResults ?? 10;\n  const transformFn = options.transformResults ?? (() => true);\n\n  const transformedResults: PagefindSearchFragment[] = [];\n\n  const generator = searchResultGenerator({\n    search,\n    transformFn,\n    auth,\n    context,\n  });\n\n  for await (const result of generator) {\n    transformedResults.push(result);\n    if (transformedResults.length >= maxResults) break;\n  }\n\n  return transformedResults;\n};\n\nasync function* searchResultGenerator({\n  search,\n  transformFn,\n  auth,\n  context,\n}: {\n  search: PagefindSearchResults;\n  transformFn: NonNullable<PagefindOptions[\"transformResults\"]>;\n  auth: AuthState<unknown>;\n  context: ZudokuContext;\n}) {\n  const batchSize = 5;\n  let processedCount = 0;\n\n  while (processedCount < search.results.length) {\n    const batch = search.results.slice(\n      processedCount,\n      processedCount + batchSize,\n    );\n    processedCount += batch.length;\n\n    const batchData = await Promise.all(batch.map((result) => result.data()));\n\n    for (const result of batchData) {\n      const transformed = transformFn({ result, auth, context });\n\n      if (transformed === false) {\n        // Skip this result\n        continue;\n      } else if (transformed === true || transformed == null) {\n        // Keep the original result\n        yield result;\n      } else {\n        // Return the transformed result\n        yield transformed;\n      }\n    }\n  }\n}\n","import { BracketsIcon, FileTextIcon } from \"lucide-react\";\nimport { useLayoutEffect, useRef } from \"react\";\nimport { Link, useNavigate } from \"react-router\";\nimport { CommandGroup, CommandItem, CommandList } from \"zudoku/ui/Command.js\";\nimport {\n  type PagefindSearchFragment,\n  type PagefindSubResult,\n} from \"./types.js\";\n\nconst sortSubResults = (a: PagefindSubResult, b: PagefindSubResult) => {\n  const aScore = a.weighted_locations.reduce(\n    (sum, loc) => sum + loc.balanced_score,\n    0,\n  );\n  const bScore = b.weighted_locations.reduce(\n    (sum, loc) => sum + loc.balanced_score,\n    0,\n  );\n  return bScore - aScore;\n};\n\nconst hoverClassname = `cursor-pointer border border-transparent data-[selected=true]:border-border`;\n\nexport const ResultList = ({\n  searchResults,\n  searchTerm,\n  onClose,\n  maxSubResults = 4,\n}: {\n  basePath?: string;\n  searchResults: PagefindSearchFragment[];\n  searchTerm: string;\n  onClose: () => void;\n  maxSubResults?: number;\n}) => {\n  const navigate = useNavigate();\n  const commandListRef = useRef<HTMLDivElement | null>(null);\n\n  useLayoutEffect(() => {\n    requestIdleCallback(() => {\n      commandListRef.current?.scrollTo({ top: 0 });\n    });\n  }, [searchTerm]);\n\n  return (\n    <CommandList className=\"max-h-[450px]\" ref={commandListRef}>\n      {searchTerm && searchResults.length > 0 && (\n        <CommandGroup\n          className=\"text-sm text-muted-foreground\"\n          heading={`${searchResults.length} results for \"${searchTerm}\"`}\n        />\n      )}\n      {searchTerm &&\n        searchResults.map((result) => (\n          <CommandGroup\n            key={[result.meta.title ?? result.excerpt, result.url].join(\"-\")}\n          >\n            <CommandItem\n              asChild\n              value={`${result.meta.title}-${result.url}`}\n              className={hoverClassname}\n              onSelect={() => {\n                void navigate(result.url);\n                onClose();\n              }}\n            >\n              <Link to={result.url}>\n                {result.meta.section === \"openapi\" ? (\n                  <BracketsIcon />\n                ) : (\n                  <FileTextIcon />\n                )}\n                {result.meta.title}\n              </Link>\n            </CommandItem>\n            {result.sub_results\n              .sort(sortSubResults)\n              .slice(0, maxSubResults)\n              .map((subResult) => (\n                <CommandItem\n                  asChild\n                  key={`sub-${result.meta.title}-${subResult.url}`}\n                  value={`sub-${result.meta.title}-${subResult.url}`}\n                  className={hoverClassname}\n                  onSelect={() => {\n                    void navigate(subResult.url);\n                    onClose();\n                  }}\n                >\n                  <Link to={subResult.url} onClick={onClose}>\n                    <div className=\"flex flex-col items-start gap-2 ms-2.5 ps-5 border-l border-muted-foreground/50\">\n                      <span className=\"font-bold\">{subResult.title}</span>\n                      <span\n                        className=\"text-[13px] [&_mark]:bg-primary [&_mark]:text-primary-foreground\"\n                        dangerouslySetInnerHTML={{ __html: subResult.excerpt }}\n                      />\n                    </div>\n                  </Link>\n                </CommandItem>\n              ))}\n          </CommandGroup>\n        ))}\n    </CommandList>\n  );\n};\n","import { VisuallyHidden } from \"@radix-ui/react-visually-hidden\";\nimport { keepPreviousData, useQuery } from \"@tanstack/react-query\";\nimport { useRef, useState } from \"react\";\nimport { Button } from \"zudoku/ui/Button.js\";\nimport { Callout } from \"zudoku/ui/Callout.js\";\nimport {\n  CommandDialog,\n  CommandEmpty,\n  CommandInput,\n} from \"zudoku/ui/Command.js\";\nimport { DialogTitle } from \"zudoku/ui/Dialog.js\";\nimport { useAuthState } from \"../../authentication/state.js\";\nimport { useZudoku } from \"../../components/context/ZudokuContext.js\";\nimport { SEARCH_PROTECTED_SECTION } from \"../../core/RouteGuard.js\";\nimport { joinUrl } from \"../../util/joinUrl.js\";\nimport { getResults } from \"./get-results.js\";\nimport type { PagefindOptions } from \"./index.js\";\nimport { ResultList } from \"./ResultList.js\";\nimport type { Pagefind } from \"./types.js\";\n\nconst DEFAULT_RANKING = {\n  // Slightly lower than default because API docs tend to have repetitive terms (parameter names, HTTP methods, etc.)\n  termFrequency: 0.8,\n  // Lower than default because API documentation pages tend to be longer due to comprehensive endpoint documentation\n  pageLength: 0.6,\n  // Slightly higher than default because in technical documentation, exact matches should be prioritized\n  termSimilarity: 1.2,\n  // Slightly lower than default because API docs might have legitimate repetition of terms\n  termSaturation: 1.2,\n};\n\nconst importPagefind = (basePath?: string): Promise<Pagefind> =>\n  import.meta.env.DEV\n    ? // @ts-expect-error TypeScript can't resolve the import\n      import(/* @vite-ignore */ \"/pagefind/pagefind.js\")\n    : import(/* @vite-ignore */ joinUrl(basePath, \"/pagefind/pagefind.js\"));\n\nconst usePagefind = (options: PagefindOptions) => {\n  const {\n    options: { basePath },\n  } = useZudoku();\n  const { data: pagefind, ...result } = useQuery<Pagefind>({\n    queryKey: [\"pagefind\", options.ranking],\n    retry: false,\n    queryFn: async () => {\n      const pagefind = await importPagefind(basePath);\n      await pagefind.init();\n      await pagefind.options({\n        ranking: {\n          termFrequency:\n            options.ranking?.termFrequency ?? DEFAULT_RANKING.termFrequency,\n          pageLength: options.ranking?.pageLength ?? DEFAULT_RANKING.pageLength,\n          termSimilarity:\n            options.ranking?.termSimilarity ?? DEFAULT_RANKING.termSimilarity,\n          termSaturation:\n            options.ranking?.termSaturation ?? DEFAULT_RANKING.termSaturation,\n        },\n      });\n\n      return pagefind;\n    },\n    enabled: typeof window !== \"undefined\",\n  });\n\n  if (result.isError && result.error.message !== \"NOT_BUILT_YET\") {\n    // eslint-disable-next-line no-console\n    console.error(result.error);\n  }\n\n  return { ...result, pagefind };\n};\n\nexport const PagefindSearch = ({\n  isOpen,\n  onClose,\n  options,\n}: {\n  isOpen: boolean;\n  onClose: () => void;\n  options: PagefindOptions;\n}) => {\n  const { pagefind, error, isError } = usePagefind(options);\n  const [searchTerm, setSearchTerm] = useState(\"\");\n  const auth = useAuthState();\n  const context = useZudoku();\n  const inputRef = useRef<HTMLInputElement>(null);\n\n  const { data: searchResults } = useQuery({\n    queryKey: [\"pagefind-search\", searchTerm, auth.isAuthenticated],\n    queryFn: async () => {\n      const filters = auth.isAuthenticated\n        ? undefined\n        : { not: { section: SEARCH_PROTECTED_SECTION } };\n\n      const search = await pagefind?.search(searchTerm, { filters });\n      if (!search) return [];\n      return getResults({ search, options, auth, context });\n    },\n    placeholderData: keepPreviousData,\n    enabled: !!pagefind && !!searchTerm,\n  });\n\n  return (\n    <CommandDialog\n      command={{ shouldFilter: false }}\n      content={{ className: \"max-w-[750px]\" }}\n      open={isOpen}\n      onOpenChange={onClose}\n    >\n      <VisuallyHidden>\n        <DialogTitle>Search</DialogTitle>\n      </VisuallyHidden>\n      <CommandInput\n        ref={inputRef}\n        placeholder=\"Search...\"\n        value={searchTerm}\n        onValueChange={setSearchTerm}\n        disabled={isError}\n      />\n      <CommandEmpty>\n        {searchTerm ? (\n          <div className=\"flex flex-col items-center\">\n            No results found.\n            <Button\n              variant=\"link\"\n              onClick={() => {\n                setSearchTerm(\"\");\n                inputRef.current?.focus();\n              }}\n            >\n              Clear search\n            </Button>\n          </div>\n        ) : (\n          \"Start typing to search\"\n        )}\n      </CommandEmpty>\n      {isError ? (\n        <div className=\"p-4 text-sm\">\n          {error.message === \"NOT_BUILT_YET\" ? (\n            <Callout type=\"info\">\n              Search is currently not available in development mode by default.\n              <br />\n              To still use search in development, run <code>\n                zudoku build\n              </code>{\" \"}\n              and copy the <code>dist/pagefind</code> directory to your{\" \"}\n              <code>public</code> directory.\n            </Callout>\n          ) : (\n            \"An error occurred while loading search.\"\n          )}\n        </div>\n      ) : (\n        <ResultList\n          searchResults={searchResults ?? []}\n          searchTerm={searchTerm}\n          onClose={onClose}\n          maxSubResults={options.maxSubResults}\n        />\n      )}\n    </CommandDialog>\n  );\n};\n","import type { ZudokuConfig } from \"../../../config/validators/validate.js\";\nimport { ClientOnly } from \"../../components/ClientOnly.js\";\nimport type { ZudokuPlugin } from \"../../core/plugins.js\";\nimport { PagefindSearch } from \"./PagefindSearch.js\";\n\nexport type PagefindOptions = Extract<\n  ZudokuConfig[\"search\"],\n  { type: \"pagefind\" }\n>;\n\nexport const pagefindSearchPlugin = (\n  options: PagefindOptions,\n): ZudokuPlugin => {\n  return {\n    renderSearch: ({ isOpen, onClose }) => (\n      <ClientOnly>\n        <PagefindSearch isOpen={isOpen} onClose={onClose} options={options} />\n      </ClientOnly>\n    ),\n  };\n};\n"],"names":["getResults","search","options","auth","context","maxResults","transformFn","transformedResults","generator","searchResultGenerator","result","processedCount","batch","batchData","transformed","sortSubResults","a","b","aScore","sum","loc","hoverClassname","ResultList","searchResults","searchTerm","onClose","maxSubResults","navigate","useNavigate","commandListRef","useRef","useLayoutEffect","jsxs","CommandList","jsx","CommandGroup","CommandItem","Link","BracketsIcon","FileTextIcon","subResult","DEFAULT_RANKING","importPagefind","basePath","joinUrl","usePagefind","useZudoku","pagefind","useQuery","PagefindSearch","isOpen","error","isError","setSearchTerm","useState","useAuthState","inputRef","filters","SEARCH_PROTECTED_SECTION","keepPreviousData","CommandDialog","VisuallyHidden","DialogTitle","CommandInput","CommandEmpty","Button","Callout","pagefindSearchPlugin","ClientOnly"],"mappings":";;;;;;;;;;;AAKO,MAAMA,IAAa,OAAO;AAAA,EAC/B,QAAAC;AAAA,EACA,SAAAC;AAAA,EACA,MAAAC;AAAA,EACA,SAAAC;AACF,MAKM;AACE,QAAAC,IAAaH,EAAQ,cAAc,IACnCI,IAAcJ,EAAQ,qBAAqB,MAAM,KAEjDK,IAA+C,CAAC,GAEhDC,IAAYC,EAAsB;AAAA,IACtC,QAAAR;AAAA,IACA,aAAAK;AAAA,IACA,MAAAH;AAAA,IACA,SAAAC;AAAA,EAAA,CACD;AAED,mBAAiBM,KAAUF;AAErB,QADJD,EAAmB,KAAKG,CAAM,GAC1BH,EAAmB,UAAUF,EAAY;AAGxC,SAAAE;AACT;AAEA,gBAAgBE,EAAsB;AAAA,EACpC,QAAAR;AAAA,EACA,aAAAK;AAAA,EACA,MAAAH;AAAA,EACA,SAAAC;AACF,GAKG;AAED,MAAIO,IAAiB;AAEd,SAAAA,IAAiBV,EAAO,QAAQ,UAAQ;AACvC,UAAAW,IAAQX,EAAO,QAAQ;AAAA,MAC3BU;AAAA,MACAA,IAAiB;AAAA,IACnB;AACA,IAAAA,KAAkBC,EAAM;AAElB,UAAAC,IAAY,MAAM,QAAQ,IAAID,EAAM,IAAI,CAACF,MAAWA,EAAO,KAAK,CAAC,CAAC;AAExE,eAAWA,KAAUG,GAAW;AAC9B,YAAMC,IAAcR,EAAY,EAAE,QAAAI,GAAQ,MAAAP,GAAM,SAAAC,GAAS;AAEzD,MAAIU,MAAgB,OAGTA,MAAgB,MAAQA,KAAe,OAE1C,MAAAJ,IAGA,MAAAI;AAAA,IACR;AAAA,EACF;AAEJ;ACjEA,MAAMC,IAAiB,CAACC,GAAsBC,MAAyB;AAC/D,QAAAC,IAASF,EAAE,mBAAmB;AAAA,IAClC,CAACG,GAAKC,MAAQD,IAAMC,EAAI;AAAA,IACxB;AAAA,EACF;AAKA,SAJeH,EAAE,mBAAmB;AAAA,IAClC,CAACE,GAAKC,MAAQD,IAAMC,EAAI;AAAA,IACxB;AAAA,EACF,IACgBF;AAClB,GAEMG,IAAiB,+EAEVC,IAAa,CAAC;AAAA,EACzB,eAAAC;AAAA,EACA,YAAAC;AAAA,EACA,SAAAC;AAAA,EACA,eAAAC,IAAgB;AAClB,MAMM;AACJ,QAAMC,IAAWC,EAAY,GACvBC,IAAiBC,EAA8B,IAAI;AAEzD,SAAAC,EAAgB,MAAM;AACpB,wBAAoB,MAAM;AACxB,MAAAF,EAAe,SAAS,SAAS,EAAE,KAAK,GAAG;AAAA,IAAA,CAC5C;AAAA,EAAA,GACA,CAACL,CAAU,CAAC,GAGZQ,gBAAAA,EAAAA,KAAAC,GAAA,EAAY,WAAU,iBAAgB,KAAKJ,GACzC,UAAA;AAAA,IAAcL,KAAAD,EAAc,SAAS,KACpCW,gBAAAA,EAAA;AAAA,MAACC;AAAA,MAAA;AAAA,QACC,WAAU;AAAA,QACV,SAAS,GAAGZ,EAAc,MAAM,iBAAiBC,CAAU;AAAA,MAAA;AAAA,IAC7D;AAAA,IAEDA,KACCD,EAAc,IAAI,CAACb,MACjBsB,gBAAAA,EAAA;AAAA,MAACG;AAAA,MAAA;AAAA,QAGC,UAAA;AAAA,UAAAD,gBAAAA,EAAA;AAAA,YAACE;AAAA,YAAA;AAAA,cACC,SAAO;AAAA,cACP,OAAO,GAAG1B,EAAO,KAAK,KAAK,IAAIA,EAAO,GAAG;AAAA,cACzC,WAAWW;AAAA,cACX,UAAU,MAAM;AACT,gBAAAM,EAASjB,EAAO,GAAG,GAChBe,EAAA;AAAA,cACV;AAAA,cAEA,UAACO,gBAAAA,EAAA,KAAAK,GAAA,EAAK,IAAI3B,EAAO,KACd,UAAA;AAAA,gBAAAA,EAAO,KAAK,YAAY,kCACtB4B,GAAa,CAAA,CAAA,0BAEbC,GAAa,EAAA;AAAA,gBAEf7B,EAAO,KAAK;AAAA,cAAA,EACf,CAAA;AAAA,YAAA;AAAA,UACF;AAAA,UACCA,EAAO,YACL,KAAKK,CAAc,EACnB,MAAM,GAAGW,CAAa,EACtB,IAAI,CAACc,MACJN,gBAAAA,EAAA;AAAA,YAACE;AAAA,YAAA;AAAA,cACC,SAAO;AAAA,cAEP,OAAO,OAAO1B,EAAO,KAAK,KAAK,IAAI8B,EAAU,GAAG;AAAA,cAChD,WAAWnB;AAAA,cACX,UAAU,MAAM;AACT,gBAAAM,EAASa,EAAU,GAAG,GACnBf,EAAA;AAAA,cACV;AAAA,cAEA,UAAAS,gBAAAA,EAAA,IAACG,GAAK,EAAA,IAAIG,EAAU,KAAK,SAASf,GAChC,UAAAO,gBAAAA,EAAAA,KAAC,OAAI,EAAA,WAAU,mFACb,UAAA;AAAA,gBAAAE,gBAAAA,EAAA,IAAC,QAAK,EAAA,WAAU,aAAa,UAAAM,EAAU,OAAM;AAAA,gBAC7CN,gBAAAA,EAAA;AAAA,kBAAC;AAAA,kBAAA;AAAA,oBACC,WAAU;AAAA,oBACV,yBAAyB,EAAE,QAAQM,EAAU,QAAQ;AAAA,kBAAA;AAAA,gBAAA;AAAA,cACvD,EAAA,CACF,EACF,CAAA;AAAA,YAAA;AAAA,YAhBK,OAAO9B,EAAO,KAAK,KAAK,IAAI8B,EAAU,GAAG;AAAA,UAkBjD,CAAA;AAAA,QAAA;AAAA,MAAA;AAAA,MA5CE,CAAC9B,EAAO,KAAK,SAASA,EAAO,SAASA,EAAO,GAAG,EAAE,KAAK,GAAG;AAAA,IA8ClE,CAAA;AAAA,EAAA,GACL;AAEJ,GCpFM+B,IAAkB;AAAA;AAAA,EAEtB,eAAe;AAAA;AAAA,EAEf,YAAY;AAAA;AAAA,EAEZ,gBAAgB;AAAA;AAAA,EAEhB,gBAAgB;AAClB,GAEMC,IAAiB,CAACC,MAIlB;AAAA;AAAA,EAA0BC,EAAQD,GAAU,uBAAuB;AAAA,GAEnEE,IAAc,CAAC3C,MAA6B;AAC1C,QAAA;AAAA,IACJ,SAAS,EAAE,UAAAyC,EAAS;AAAA,MAClBG,EAAU,GACR,EAAE,MAAMC,GAAU,GAAGrC,EAAA,IAAWsC,EAAmB;AAAA,IACvD,UAAU,CAAC,YAAY9C,EAAQ,OAAO;AAAA,IACtC,OAAO;AAAA,IACP,SAAS,YAAY;AACb6C,YAAAA,IAAW,MAAML,EAAeC,CAAQ;AAC9C,mBAAMI,EAAS,KAAK,GACpB,MAAMA,EAAS,QAAQ;AAAA,QACrB,SAAS;AAAA,UACP,eACE7C,EAAQ,SAAS,iBAAiBuC,EAAgB;AAAA,UACpD,YAAYvC,EAAQ,SAAS,cAAcuC,EAAgB;AAAA,UAC3D,gBACEvC,EAAQ,SAAS,kBAAkBuC,EAAgB;AAAA,UACrD,gBACEvC,EAAQ,SAAS,kBAAkBuC,EAAgB;AAAA,QAAA;AAAA,MACvD,CACD,GAEMM;AAAAA,IACT;AAAA,IACA,SAAS,OAAO,SAAW;AAAA,EAAA,CAC5B;AAED,SAAIrC,EAAO,WAAWA,EAAO,MAAM,YAAY,mBAErC,QAAA,MAAMA,EAAO,KAAK,GAGrB,EAAE,GAAGA,GAAQ,UAAAqC,EAAS;AAC/B,GAEaE,IAAiB,CAAC;AAAA,EAC7B,QAAAC;AAAA,EACA,SAAAzB;AAAA,EACA,SAAAvB;AACF,MAIM;AACJ,QAAM,EAAE,UAAA6C,GAAU,OAAAI,GAAO,SAAAC,EAAQ,IAAIP,EAAY3C,CAAO,GAClD,CAACsB,GAAY6B,CAAa,IAAIC,EAAS,EAAE,GACzCnD,IAAOoD,EAAa,GACpBnD,IAAU0C,EAAU,GACpBU,IAAW1B,EAAyB,IAAI,GAExC,EAAE,MAAMP,EAAc,IAAIyB,EAAS;AAAA,IACvC,UAAU,CAAC,mBAAmBxB,GAAYrB,EAAK,eAAe;AAAA,IAC9D,SAAS,YAAY;AACb,YAAAsD,IAAUtD,EAAK,kBACjB,SACA,EAAE,KAAK,EAAE,SAASuD,IAA2B,GAE3CzD,IAAS,MAAM8C,GAAU,OAAOvB,GAAY,EAAE,SAAAiC,GAAS;AACzD,aAACxD,IACED,EAAW,EAAE,QAAAC,GAAQ,SAAAC,GAAS,MAAAC,GAAM,SAAAC,GAAS,IADhC,CAAC;AAAA,IAEvB;AAAA,IACA,iBAAiBuD;AAAA,IACjB,SAAS,CAAC,CAACZ,KAAY,CAAC,CAACvB;AAAA,EAAA,CAC1B;AAGC,SAAAQ,gBAAAA,EAAA;AAAA,IAAC4B;AAAA,IAAA;AAAA,MACC,SAAS,EAAE,cAAc,GAAM;AAAA,MAC/B,SAAS,EAAE,WAAW,gBAAgB;AAAA,MACtC,MAAMV;AAAA,MACN,cAAczB;AAAA,MAEd,UAAA;AAAA,QAAAS,gBAAAA,MAAC2B,GACC,EAAA,UAAA3B,gBAAAA,EAAA,IAAC4B,GAAY,EAAA,UAAA,SAAM,CAAA,GACrB;AAAA,QACA5B,gBAAAA,EAAA;AAAA,UAAC6B;AAAA,UAAA;AAAA,YACC,KAAKP;AAAA,YACL,aAAY;AAAA,YACZ,OAAOhC;AAAA,YACP,eAAe6B;AAAA,YACf,UAAUD;AAAA,UAAA;AAAA,QACZ;AAAA,8BACCY,GACE,EAAA,UAAAxC,2BACE,OAAA,EAAI,WAAU,8BAA6B,UAAA;AAAA,UAAA;AAAA,UAE1CU,gBAAAA,EAAA;AAAA,YAAC+B;AAAA,YAAA;AAAA,cACC,SAAQ;AAAA,cACR,SAAS,MAAM;AACb,gBAAAZ,EAAc,EAAE,GAChBG,EAAS,SAAS,MAAM;AAAA,cAC1B;AAAA,cACD,UAAA;AAAA,YAAA;AAAA,UAAA;AAAA,QAED,EACF,CAAA,IAEA,0BAEJ;AAAA,QACCJ,IACElB,gBAAAA,EAAA,IAAA,OAAA,EAAI,WAAU,eACZ,UAAMiB,EAAA,YAAY,kBAChBnB,gBAAAA,EAAAA,KAAAkC,GAAQ,EAAA,MAAK,QAAO,UAAA;AAAA,UAAA;AAAA,gCAElB,MAAG,EAAA;AAAA,UAAE;AAAA,UACmChC,gBAAAA,EAAAA,IAAA,UAAK,UAE9C,gBAAA;AAAA,UAAQ;AAAA,UAAI;AAAA,UACEA,gBAAAA,EAAAA,IAAA,UAAK,UAAa,iBAAA;AAAA,UAAO;AAAA,UAAmB;AAAA,UACzDA,gBAAAA,EAAAA,IAAA,UAAK,UAAM,UAAA;AAAA,UAAO;AAAA,QAAA,GACrB,IAEA,0CAEJ,CAAA,IAEAA,gBAAAA,EAAA;AAAA,UAACZ;AAAA,UAAA;AAAA,YACC,eAAeC,KAAiB,CAAC;AAAA,YACjC,YAAAC;AAAA,YACA,SAAAC;AAAA,YACA,eAAevB,EAAQ;AAAA,UAAA;AAAA,QAAA;AAAA,MACzB;AAAA,IAAA;AAAA,EAEJ;AAEJ,GCzJaiE,KAAuB,CAClCjE,OAEO;AAAA,EACL,cAAc,CAAC,EAAE,QAAAgD,GAAQ,SAAAzB,EAAQ,MAC9BS,gBAAAA,EAAAA,IAAAkC,GAAA,EACC,UAAClC,gBAAAA,EAAA,IAAAe,GAAA,EAAe,QAAAC,GAAgB,SAAAzB,GAAkB,SAAAvB,EAAkB,CAAA,EACtE,CAAA;AAEJ;"}

package/lib/zudoku.plugins.js

@@ -0,0 +1,15 @@
+const e = (n) => n, t = (n) => n, i = (n) => "events" in n && typeof n.events == "object", o = (n) => "getProfileMenuItems" in n && typeof n.getProfileMenuItems == "function", s = (n) => "getRoutes" in n && typeof n.getRoutes == "function", c = (n) => "signUp" in n && typeof n.signUp == "function", u = (n) => "renderSearch" in n && typeof n.renderSearch == "function", g = (n) => "initialize" in n && typeof n.initialize == "function", f = (n) => "getHead" in n && typeof n.getHead == "function", r = (n) => "getMdxComponents" in n && typeof n.getMdxComponents == "function", a = (n) => "getIdentities" in n && typeof n.getIdentities == "function";
+export {
+  e as createApiIdentityPlugin,
+  t as createProfileMenuPlugin,
+  f as hasHead,
+  a as isApiIdentityPlugin,
+  c as isAuthenticationPlugin,
+  i as isEventConsumerPlugin,
+  r as isMdxProviderPlugin,
+  s as isNavigationPlugin,
+  o as isProfileMenuPlugin,
+  u as isSearchPlugin,
+  g as needsInitialization
+};
+//# sourceMappingURL=zudoku.plugins.js.map

package/lib/zudoku.plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zudoku.plugins.js","sources":["../src/lib/core/plugins.ts"],"sourcesContent":["import type { LucideIcon } from \"lucide-react\";\nimport type { ReactElement } from \"react\";\nimport type { Location, RouteObject } from \"react-router\";\nimport type { Sidebar } from \"../../config/validators/SidebarSchema.js\";\nimport type { AuthenticationPlugin } from \"../authentication/authentication.js\";\nimport type { MdxComponentsType } from \"../util/MdxComponents.js\";\nimport type {\n  ApiIdentity,\n  ZudokuContext,\n  ZudokuEvents,\n} from \"./ZudokuContext.js\";\n\nexport type ZudokuPlugin =\n  | CommonPlugin\n  | ProfileMenuPlugin\n  | NavigationPlugin\n  | ApiIdentityPlugin\n  | SearchProviderPlugin\n  | EventConsumerPlugin\n  | AuthenticationPlugin;\n\nexport type { AuthenticationPlugin, RouteObject };\n\nexport interface NavigationPlugin {\n  getRoutes: () => RouteObject[];\n  getSidebar?: (path: string, context: ZudokuContext) => Promise<Sidebar>;\n  getProtectedRoutes?: () => string[];\n}\n\nexport const createApiIdentityPlugin = (\n  plugin: ApiIdentityPlugin,\n): ApiIdentityPlugin => plugin;\n\nexport const createProfileMenuPlugin = (\n  plugin: ProfileMenuPlugin,\n): ProfileMenuPlugin => plugin;\n\nexport interface ApiIdentityPlugin {\n  getIdentities: (context: ZudokuContext) => Promise<ApiIdentity[]>;\n}\n\nexport interface SearchProviderPlugin {\n  renderSearch: (o: {\n    isOpen: boolean;\n    onClose: () => void;\n  }) => React.JSX.Element | null;\n}\n\nexport interface ProfileMenuPlugin {\n  getProfileMenuItems: (context: ZudokuContext) => ProfileNavigationItem[];\n}\n\nexport type ProfileNavigationItem = {\n  label: string;\n  path?: string;\n  weight?: number;\n  category?: \"top\" | \"middle\" | \"bottom\";\n  children?: ProfileNavigationItem[];\n  icon?: LucideIcon;\n};\n\nexport interface CommonPlugin {\n  initialize?: (\n    context: ZudokuContext,\n  ) => Promise<void | boolean> | void | boolean;\n  getHead?: ({ location }: { location: Location }) => ReactElement | undefined;\n  getMdxComponents?: () => MdxComponentsType;\n}\n\nexport type EventConsumerPlugin<Event extends ZudokuEvents = ZudokuEvents> = {\n  events: { [K in keyof Event]?: Event[K] };\n};\n\nexport const isEventConsumerPlugin = (\n  obj: ZudokuPlugin,\n): obj is EventConsumerPlugin =>\n  \"events\" in obj && typeof obj.events === \"object\";\n\nexport const isProfileMenuPlugin = (\n  obj: ZudokuPlugin,\n): obj is ProfileMenuPlugin =>\n  \"getProfileMenuItems\" in obj && typeof obj.getProfileMenuItems === \"function\";\n\nexport const isNavigationPlugin = (\n  obj: ZudokuPlugin,\n): obj is NavigationPlugin =>\n  \"getRoutes\" in obj && typeof obj.getRoutes === \"function\";\n\nexport const isAuthenticationPlugin = (\n  obj: ZudokuPlugin,\n): obj is AuthenticationPlugin =>\n  \"signUp\" in obj && typeof obj.signUp === \"function\";\n\nexport const isSearchPlugin = (\n  obj: ZudokuPlugin,\n): obj is SearchProviderPlugin =>\n  \"renderSearch\" in obj && typeof obj.renderSearch === \"function\";\n\nexport const needsInitialization = (obj: ZudokuPlugin): obj is CommonPlugin =>\n  \"initialize\" in obj && typeof obj.initialize === \"function\";\n\nexport const hasHead = (obj: ZudokuPlugin): obj is CommonPlugin =>\n  \"getHead\" in obj && typeof obj.getHead === \"function\";\n\nexport const isMdxProviderPlugin = (obj: ZudokuPlugin): obj is CommonPlugin =>\n  \"getMdxComponents\" in obj && typeof obj.getMdxComponents === \"function\";\n\nexport const isApiIdentityPlugin = (\n  obj: ZudokuPlugin,\n): obj is ApiIdentityPlugin =>\n  \"getIdentities\" in obj && typeof obj.getIdentities === \"function\";\n"],"names":["createApiIdentityPlugin","plugin","createProfileMenuPlugin","isEventConsumerPlugin","obj","isProfileMenuPlugin","isNavigationPlugin","isAuthenticationPlugin","isSearchPlugin","needsInitialization","hasHead","isMdxProviderPlugin","isApiIdentityPlugin"],"mappings":"AA6Ba,MAAAA,IAA0B,CACrCC,MACsBA,GAEXC,IAA0B,CACrCD,MACsBA,GAsCXE,IAAwB,CACnCC,MAEA,YAAYA,KAAO,OAAOA,EAAI,UAAW,UAE9BC,IAAsB,CACjCD,MAEA,yBAAyBA,KAAO,OAAOA,EAAI,uBAAwB,YAExDE,IAAqB,CAChCF,MAEA,eAAeA,KAAO,OAAOA,EAAI,aAAc,YAEpCG,IAAyB,CACpCH,MAEA,YAAYA,KAAO,OAAOA,EAAI,UAAW,YAE9BI,IAAiB,CAC5BJ,MAEA,kBAAkBA,KAAO,OAAOA,EAAI,gBAAiB,YAE1CK,IAAsB,CAACL,MAClC,gBAAgBA,KAAO,OAAOA,EAAI,cAAe,YAEtCM,IAAU,CAACN,MACtB,aAAaA,KAAO,OAAOA,EAAI,WAAY,YAEhCO,IAAsB,CAACP,MAClC,sBAAsBA,KAAO,OAAOA,EAAI,oBAAqB,YAElDQ,IAAsB,CACjCR,MAEA,mBAAmBA,KAAO,OAAOA,EAAI,iBAAkB;"}