zudoku 0.37.1 → 0.38.0

package/dist/config/validators/validate.d.ts

@@ -7,6 +7,7 @@ import { type MdxComponentsType } from "../../lib/util/MdxComponents.js";
 declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
     protectedRoutes: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
     basePath: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    canonicalUrlOrigin: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     cdnUrl: z.ZodOptional<z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
         base: z.ZodOptional<z.ZodString>;
         media: z.ZodOptional<z.ZodString>;
@@ -583,7 +584,15 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         }>>;
         maxResults: z.ZodOptional<z.ZodNumber>;
         maxSubResults: z.ZodOptional<z.ZodNumber>;
-        transformResults: z.ZodOptional<z.ZodType<(result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void, z.ZodTypeDef, (result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void>>;
+        transformResults: z.ZodOptional<z.ZodType<(data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void, z.ZodTypeDef, (data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void>>;
     }, "strip", z.ZodTypeAny, {
         type: "pagefind";
         ranking?: {
@@ -594,7 +603,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     }, {
         type: "pagefind";
         ranking?: {
@@ -605,7 +618,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     }>]>>>;
     docs: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         files: z.ZodString;
@@ -678,16 +695,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, "strip", z.ZodTypeAny, {
         type: "url";
@@ -699,6 +719,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -715,6 +736,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -743,16 +765,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, {
         postProcessors: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>], z.ZodUnknown>, z.ZodUnion<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, z.ZodPromise<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>]>>, "many">>;
@@ -766,6 +791,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -783,6 +809,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -812,16 +839,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, "strip", z.ZodTypeAny, {
         type: "raw";
@@ -833,6 +863,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -849,6 +880,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -877,16 +909,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, "strip", z.ZodTypeAny, {
         type: "url";
@@ -898,6 +933,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -914,6 +950,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -942,16 +979,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, {
         postProcessors: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>], z.ZodUnknown>, z.ZodUnion<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, z.ZodPromise<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>]>>, "many">>;
@@ -965,6 +1005,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -982,6 +1023,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1011,16 +1053,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>>;
     }>, "strip", z.ZodTypeAny, {
         type: "raw";
@@ -1032,6 +1077,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1048,6 +1094,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1181,16 +1228,19 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground: z.ZodOptional<z.ZodBoolean>;
             showVersionSelect: z.ZodOptional<z.ZodEnum<["always", "if-available", "hide"]>>;
             expandAllTags: z.ZodOptional<z.ZodBoolean>;
+            transformExamples: z.ZodOptional<z.ZodType<import("../../lib/plugins/openapi/interfaces.js").transformExamples, z.ZodTypeDef, import("../../lib/plugins/openapi/interfaces.js").transformExamples>>;
         }, "strip", z.ZodTypeAny, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }, {
             examplesLanguage?: string | undefined;
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         }>;
         examplesLanguage: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
@@ -1199,6 +1249,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     }, {
@@ -1207,6 +1258,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     }>>;
@@ -1260,7 +1312,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     } | undefined;
     plugins?: ZudokuPlugin[] | undefined;
     defaults?: {
@@ -1269,6 +1325,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     } | undefined;
@@ -1396,6 +1453,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     protectedRoutes?: string[] | undefined;
     basePath?: string | undefined;
+    canonicalUrlOrigin?: string | undefined;
     cdnUrl?: {
         base: string | undefined;
         media: string | undefined;
@@ -1446,6 +1504,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1462,6 +1521,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1479,6 +1539,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1495,6 +1556,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1511,6 +1573,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1528,6 +1591,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1595,7 +1659,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     } | undefined;
     plugins?: ZudokuPlugin[] | undefined;
     defaults?: {
@@ -1604,6 +1672,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     } | undefined;
@@ -1731,6 +1800,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     protectedRoutes?: string[] | undefined;
     basePath?: string | undefined;
+    canonicalUrlOrigin?: string | undefined;
     cdnUrl?: string | {
         base?: string | undefined;
         media?: string | undefined;
@@ -1781,6 +1851,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1797,6 +1868,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1814,6 +1886,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1830,6 +1903,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1846,6 +1920,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1863,6 +1938,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -1930,7 +2006,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     } | undefined;
     plugins?: ZudokuPlugin[] | undefined;
     defaults?: {
@@ -1939,6 +2019,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     } | undefined;
@@ -2066,6 +2147,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     protectedRoutes?: string[] | undefined;
     basePath?: string | undefined;
+    canonicalUrlOrigin?: string | undefined;
     cdnUrl?: {
         base: string | undefined;
         media: string | undefined;
@@ -2116,6 +2198,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2132,6 +2215,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2149,6 +2233,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2165,6 +2250,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2181,6 +2267,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2198,6 +2285,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2265,7 +2353,11 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
         } | undefined;
         maxResults?: number | undefined;
         maxSubResults?: number | undefined;
-        transformResults?: ((result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
+        transformResults?: ((data: {
+            result: import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment;
+            auth: import("../../lib/authentication/state.js").AuthState;
+            context: import("../../index.js").ZudokuContext;
+        }) => import("../../lib/plugins/search-pagefind/types.js").PagefindSearchFragment | boolean | undefined | void) | undefined;
     } | undefined;
     plugins?: ZudokuPlugin[] | undefined;
     defaults?: {
@@ -2274,6 +2366,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         };
         examplesLanguage?: string | undefined;
     } | undefined;
@@ -2401,6 +2494,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     protectedRoutes?: string[] | undefined;
     basePath?: string | undefined;
+    canonicalUrlOrigin?: string | undefined;
     cdnUrl?: string | {
         base?: string | undefined;
         media?: string | undefined;
@@ -2451,6 +2545,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2467,6 +2562,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2484,6 +2580,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2500,6 +2597,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2516,6 +2614,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {
@@ -2533,6 +2632,7 @@ declare const ConfigSchema: z.ZodEffects<z.ZodObject<{
             disablePlayground?: boolean | undefined;
             showVersionSelect?: "hide" | "always" | "if-available" | undefined;
             expandAllTags?: boolean | undefined;
+            transformExamples?: import("../../lib/plugins/openapi/interfaces.js").transformExamples | undefined;
         } | undefined;
         navigationId?: string | undefined;
         categories?: {

package/dist/lib/authentication/authentication.d.ts

@@ -10,6 +10,7 @@ export interface AuthenticationProvider {
     getAccessToken(): Promise<string>;
     getAuthenticationPlugin?(): ZudokuPlugin;
     onPageLoad?(): void;
+    signRequest(request: Request): Promise<Request>;
 }
 export interface AuthenticationProviderInitializer<TConfig> {
     (config: TConfig): AuthenticationProvider;

package/dist/lib/authentication/providers/clerk.js

@@ -24,6 +24,9 @@ class ClerkAuthPlugin extends AuthenticationPlugin {
                     emailVerified: verifiedEmail !== undefined,
                     pictureUrl: clerk.session.user.imageUrl,
                 },
+                providerData: {
+                    user: clerk.session.user,
+                },
             });
         }
         else {
@@ -56,6 +59,15 @@ const clerkAuth = ({ clerkPubKey, redirectToAfterSignOut = "/", redirectToAfterS
                     emailVerified: verifiedEmail !== undefined,
                     pictureUrl: clerkApi.user.imageUrl,
                 },
+                providerData: {
+                    user: {
+                        publicMetadata: clerkApi.user.publicMetadata,
+                        id: clerkApi.user.id,
+                        emailAddresses: clerkApi.user.emailAddresses,
+                        imageUrl: clerkApi.user.imageUrl,
+                        fullName: clerkApi.user.fullName,
+                    },
+                },
             });
         }
         return clerkApi;
@@ -71,8 +83,15 @@ const clerkAuth = ({ clerkPubKey, redirectToAfterSignOut = "/", redirectToAfterS
         }
         return response;
     }
+    async function signRequest(request) {
+        const response = await getAccessToken();
+        request.headers.set("Authorization", `Bearer ${response}`);
+        return request;
+    }
     return {
+        clerk: clerkApi,
         getAccessToken,
+        signRequest,
         signOut: async () => {
             await ensureLoaded;
             await clerkApi?.signOut({