zudoku 0.0.0-e5be921 → 0.0.0-e614aaa

package/src/lib/plugins/openapi/graphql/gql.ts

@@ -12,17 +12,27 @@ import * as types from "./graphql.js";
  * Therefore it is highly recommended to use the babel or swc plugin for production.
  * Learn more about it here: https://the-guild.dev/graphql/codegen/plugins/presets/preset-client#reducing-bundle-size
  */
-const documents = {
+type Documents = {
+  "\n  query ServersQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n": typeof types.ServersQueryDocument;
+  "\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n      examples {\n        name\n        description\n        externalValue\n        value\n        summary\n      }\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n": typeof types.OperationsFragmentFragmentDoc;
+  "\n  query AllOperations(\n    $input: JSON!\n    $type: SchemaType!\n    $tag: String\n    $untagged: Boolean\n  ) {\n    schema(input: $input, type: $type) {\n      servers {\n        url\n      }\n      description\n      summary\n      title\n      url\n      version\n      tags(name: $tag) {\n        name\n        description\n      }\n      operations(tag: $tag, untagged: $untagged) {\n        slug\n        ...OperationsFragment\n      }\n    }\n  }\n": typeof types.AllOperationsDocument;
+  "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n": typeof types.GetServerQueryDocument;
+  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        name\n      }\n    }\n  }\n": typeof types.GetCategoriesDocument;
+  "\n  query GetOperations($input: JSON!, $type: SchemaType!, $tag: String) {\n    schema(input: $input, type: $type) {\n      operations(tag: $tag) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n        tags {\n          name\n        }\n      }\n      untagged: operations(untagged: true) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n      }\n    }\n  }\n": typeof types.GetOperationsDocument;
+};
+const documents: Documents = {
   "\n  query ServersQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n":
     types.ServersQueryDocument,
   "\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n      examples {\n        name\n        description\n        externalValue\n        value\n        summary\n      }\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n":
     types.OperationsFragmentFragmentDoc,
-  "\n  query AllOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      description\n      summary\n      title\n      url\n      version\n      tags {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n      }\n    }\n  }\n":
+  "\n  query AllOperations(\n    $input: JSON!\n    $type: SchemaType!\n    $tag: String\n    $untagged: Boolean\n  ) {\n    schema(input: $input, type: $type) {\n      servers {\n        url\n      }\n      description\n      summary\n      title\n      url\n      version\n      tags(name: $tag) {\n        name\n        description\n      }\n      operations(tag: $tag, untagged: $untagged) {\n        slug\n        ...OperationsFragment\n      }\n    }\n  }\n":
     types.AllOperationsDocument,
   "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n":
     types.GetServerQueryDocument,
-  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n":
+  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        name\n      }\n    }\n  }\n":
     types.GetCategoriesDocument,
+  "\n  query GetOperations($input: JSON!, $type: SchemaType!, $tag: String) {\n    schema(input: $input, type: $type) {\n      operations(tag: $tag) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n        tags {\n          name\n        }\n      }\n      untagged: operations(untagged: true) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n      }\n    }\n  }\n":
+    types.GetOperationsDocument,
 };
 
 /**
@@ -41,7 +51,7 @@ export function graphql(
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: "\n  query AllOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      description\n      summary\n      title\n      url\n      version\n      tags {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n      }\n    }\n  }\n",
+  source: "\n  query AllOperations(\n    $input: JSON!\n    $type: SchemaType!\n    $tag: String\n    $untagged: Boolean\n  ) {\n    schema(input: $input, type: $type) {\n      servers {\n        url\n      }\n      description\n      summary\n      title\n      url\n      version\n      tags(name: $tag) {\n        name\n        description\n      }\n      operations(tag: $tag, untagged: $untagged) {\n        slug\n        ...OperationsFragment\n      }\n    }\n  }\n",
 ): typeof import("./graphql.js").AllOperationsDocument;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
@@ -53,8 +63,14 @@ export function graphql(
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n",
+  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        name\n      }\n    }\n  }\n",
 ): typeof import("./graphql.js").GetCategoriesDocument;
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(
+  source: "\n  query GetOperations($input: JSON!, $type: SchemaType!, $tag: String) {\n    schema(input: $input, type: $type) {\n      operations(tag: $tag) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n        tags {\n          name\n        }\n      }\n      untagged: operations(untagged: true) {\n        slug\n        deprecated\n        method\n        summary\n        operationId\n        path\n      }\n    }\n  }\n",
+): typeof import("./graphql.js").GetOperationsDocument;
 
 export function graphql(source: string) {
   return (documents as any)[source] ?? {};

package/src/lib/plugins/openapi/graphql/graphql.ts

@@ -31,6 +31,8 @@ export type Scalars = {
   JSON: { input: any; output: any };
   /** The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
   JSONObject: { input: any; output: any };
+  /** OpenAPI schema scalar type that handles circular references */
+  JSONSchema: { input: any; output: any };
 };
 
 export type EncodingItem = {
@@ -57,7 +59,7 @@ export type MediaTypeObject = {
   encoding?: Maybe<Array<EncodingItem>>;
   examples?: Maybe<Array<ExampleItem>>;
   mediaType: Scalars["String"]["output"];
-  schema?: Maybe<Scalars["JSON"]["output"]>;
+  schema?: Maybe<Scalars["JSONSchema"]["output"]>;
 };
 
 export type OperationItem = {
@@ -89,7 +91,7 @@ export type ParameterItem = {
   in: ParameterIn;
   name: Scalars["String"]["output"];
   required?: Maybe<Scalars["Boolean"]["output"]>;
-  schema?: Maybe<Scalars["JSON"]["output"]>;
+  schema?: Maybe<Scalars["JSONSchema"]["output"]>;
   style?: Maybe<Scalars["String"]["output"]>;
 };
 
@@ -132,11 +134,11 @@ export type Schema = {
   operations: Array<OperationItem>;
   paths: Array<PathItem>;
   servers: Array<Server>;
+  summary?: Maybe<Scalars["String"]["output"]>;
   tags: Array<SchemaTag>;
   title: Scalars["String"]["output"];
-  url: Scalars["String"]["output"];
+  url?: Maybe<Scalars["String"]["output"]>;
   version: Scalars["String"]["output"];
-  summary?: Maybe<Scalars["String"]["output"]>;
 };
 
 export type SchemaOperationsArgs = {
@@ -144,6 +146,7 @@ export type SchemaOperationsArgs = {
   operationId?: InputMaybe<Scalars["String"]["input"]>;
   path?: InputMaybe<Scalars["String"]["input"]>;
   tag?: InputMaybe<Scalars["String"]["input"]>;
+  untagged?: InputMaybe<Scalars["Boolean"]["input"]>;
 };
 
 export type SchemaTagsArgs = {
@@ -153,7 +156,7 @@ export type SchemaTagsArgs = {
 export type SchemaTag = {
   __typename?: "SchemaTag";
   description?: Maybe<Scalars["String"]["output"]>;
-  name?: Maybe<Scalars["String"]["output"]>;
+  name: Scalars["String"]["output"];
   operations: Array<OperationItem>;
 };
 
@@ -180,7 +183,7 @@ export type ServersQueryQuery = {
   __typename?: "Query";
   schema: {
     __typename?: "Schema";
-    url: string;
+    url?: string | null;
     servers: Array<{ __typename?: "Server"; url: string }>;
   };
 };
@@ -255,6 +258,8 @@ export type OperationsFragmentFragment = {
 export type AllOperationsQueryVariables = Exact<{
   input: Scalars["JSON"]["input"];
   type: SchemaType;
+  tag?: InputMaybe<Scalars["String"]["input"]>;
+  untagged?: InputMaybe<Scalars["Boolean"]["input"]>;
 }>;
 
 export type AllOperationsQuery = {
@@ -264,20 +269,21 @@ export type AllOperationsQuery = {
     description?: string | null;
     summary?: string | null;
     title: string;
-    url: string;
+    url?: string | null;
     version: string;
+    servers: Array<{ __typename?: "Server"; url: string }>;
     tags: Array<{
       __typename?: "SchemaTag";
-      name?: string | null;
+      name: string;
       description?: string | null;
-      operations: Array<
-        { __typename?: "OperationItem"; slug: string } & {
-          " $fragmentRefs"?: {
-            OperationsFragmentFragment: OperationsFragmentFragment;
-          };
-        }
-      >;
     }>;
+    operations: Array<
+      { __typename?: "OperationItem"; slug: string } & {
+        " $fragmentRefs"?: {
+          OperationsFragmentFragment: OperationsFragmentFragment;
+        };
+      }
+    >;
   };
 };
 
@@ -290,7 +296,7 @@ export type GetServerQueryQuery = {
   __typename?: "Query";
   schema: {
     __typename?: "Schema";
-    url: string;
+    url?: string | null;
     servers: Array<{ __typename?: "Server"; url: string }>;
   };
 };
@@ -304,19 +310,39 @@ export type GetCategoriesQuery = {
   __typename?: "Query";
   schema: {
     __typename?: "Schema";
-    url: string;
-    tags: Array<{
-      __typename: "SchemaTag";
-      name?: string | null;
-      operations: Array<{
-        __typename: "OperationItem";
-        slug: string;
-        deprecated?: boolean | null;
-        method: string;
-        summary?: string | null;
-        operationId?: string | null;
-        path: string;
-      }>;
+    url?: string | null;
+    tags: Array<{ __typename?: "SchemaTag"; name: string }>;
+  };
+};
+
+export type GetOperationsQueryVariables = Exact<{
+  input: Scalars["JSON"]["input"];
+  type: SchemaType;
+  tag?: InputMaybe<Scalars["String"]["input"]>;
+}>;
+
+export type GetOperationsQuery = {
+  __typename?: "Query";
+  schema: {
+    __typename?: "Schema";
+    operations: Array<{
+      __typename?: "OperationItem";
+      slug: string;
+      deprecated?: boolean | null;
+      method: string;
+      summary?: string | null;
+      operationId?: string | null;
+      path: string;
+      tags?: Array<{ __typename?: "TagItem"; name: string }> | null;
+    }>;
+    untagged: Array<{
+      __typename?: "OperationItem";
+      slug: string;
+      deprecated?: boolean | null;
+      method: string;
+      summary?: string | null;
+      operationId?: string | null;
+      path: string;
     }>;
   };
 };
@@ -418,20 +444,23 @@ export const ServersQueryDocument = new TypedDocumentString(`
   ServersQueryQueryVariables
 >;
 export const AllOperationsDocument = new TypedDocumentString(`
-    query AllOperations($input: JSON!, $type: SchemaType!) {
+    query AllOperations($input: JSON!, $type: SchemaType!, $tag: String, $untagged: Boolean) {
   schema(input: $input, type: $type) {
+    servers {
+      url
+    }
     description
     summary
     title
     url
     version
-    tags {
+    tags(name: $tag) {
       name
       description
-      operations {
-        slug
-        ...OperationsFragment
-      }
+    }
+    operations(tag: $tag, untagged: $untagged) {
+      slug
+      ...OperationsFragment
     }
   }
 }
@@ -517,17 +546,7 @@ export const GetCategoriesDocument = new TypedDocumentString(`
   schema(input: $input, type: $type) {
     url
     tags {
-      __typename
       name
-      operations {
-        __typename
-        slug
-        deprecated
-        method
-        summary
-        operationId
-        path
-      }
     }
   }
 }
@@ -535,3 +554,31 @@ export const GetCategoriesDocument = new TypedDocumentString(`
   GetCategoriesQuery,
   GetCategoriesQueryVariables
 >;
+export const GetOperationsDocument = new TypedDocumentString(`
+    query GetOperations($input: JSON!, $type: SchemaType!, $tag: String) {
+  schema(input: $input, type: $type) {
+    operations(tag: $tag) {
+      slug
+      deprecated
+      method
+      summary
+      operationId
+      path
+      tags {
+        name
+      }
+    }
+    untagged: operations(untagged: true) {
+      slug
+      deprecated
+      method
+      summary
+      operationId
+      path
+    }
+  }
+}
+    `) as unknown as TypedDocumentString<
+  GetOperationsQuery,
+  GetOperationsQueryVariables
+>;

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

@@ -1,57 +1,70 @@
-import { matchPath, type RouteObject } from "react-router-dom";
-import { type ZudokuPlugin } from "../../core/plugins.js";
-import { graphql } from "./graphql/index.js";
-
-import { useQuery } from "@tanstack/react-query";
+import type { ResultOf } from "@graphql-typed-document-node/core";
+import slugify from "@sindresorhus/slugify";
 import { CirclePlayIcon, LogInIcon } from "lucide-react";
-import type { SidebarItem } from "../../../config/validators/SidebarSchema.js";
+import { ReactNode } from "react";
+import { matchPath } from "react-router";
 import { useAuth } from "../../authentication/hook.js";
-import { ColorMap } from "../../components/navigation/SidebarBadge.js";
+import { type ZudokuPlugin } from "../../core/plugins.js";
+import type { SchemaImports } from "../../oas/graphql/index.js";
 import { Button } from "../../ui/Button.js";
-import { joinPath } from "../../util/joinPath.js";
+import { joinUrl } from "../../util/joinUrl.js";
 import { GraphQLClient } from "./client/GraphQLClient.js";
+import { graphql } from "./graphql/index.js";
 import { OasPluginConfig } from "./interfaces.js";
 import type { PlaygroundContentProps } from "./playground/Playground.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
+import { createSidebarCategory } from "./util/createSidebarCategory.js";
+import { getRoutes, getVersions } from "./util/getRoutes.js";
 
 const GetCategoriesQuery = graphql(`
   query GetCategories($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
       url
       tags {
-        __typename
         name
-        operations {
-          __typename
-          slug
-          deprecated
-          method
-          summary
-          operationId
-          path
+      }
+    }
+  }
+`);
+
+const GetOperationsQuery = graphql(`
+  query GetOperations($input: JSON!, $type: SchemaType!, $tag: String) {
+    schema(input: $input, type: $type) {
+      operations(tag: $tag) {
+        slug
+        deprecated
+        method
+        summary
+        operationId
+        path
+        tags {
+          name
         }
       }
+      untagged: operations(untagged: true) {
+        slug
+        deprecated
+        method
+        summary
+        operationId
+        path
+      }
     }
   }
 `);
 
-type InternalOasPluginConfig = { inMemory?: boolean };
+export type OperationResult = ResultOf<
+  typeof GetOperationsQuery
+>["schema"]["operations"][number];
 
-const MethodColorMap: Record<string, keyof typeof ColorMap> = {
-  get: "green",
-  post: "blue",
-  put: "yellow",
-  delete: "red",
-  patch: "purple",
-  options: "gray",
-  head: "gray",
-};
+type InternalOasPluginConfig = { schemaImports?: SchemaImports };
 
 export type OpenApiPluginOptions = OasPluginConfig & InternalOasPluginConfig;
 
-export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
-  const basePath = joinPath(config.navigationId ?? "/reference");
+export const UNTAGGED_PATH = "~endpoints";
 
+export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
+  const basePath = joinUrl(config.navigationId ?? "/reference");
   const client = new GraphQLClient(config);
 
   return {
@@ -77,19 +90,19 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
         server,
         method,
         url,
+        children,
         ...props
-      }: Partial<PlaygroundContentProps> & { requireAuth: boolean }) => {
+      }: Partial<PlaygroundContentProps> & { children: ReactNode } & Pick<
+          PlaygroundContentProps,
+          "server"
+        > & {
+          requireAuth: boolean;
+        }) => {
         const auth = useAuth();
-        // We don't have the GraphQL context here
-        const serverQuery = useQuery({
-          queryFn: () =>
-            client.fetch(GetCategoriesQuery, {
-              type: config.type,
-              input: config.input,
-            }),
-          enabled: !server,
-          queryKey: ["playground-server"],
-        });
+
+        if (!server) {
+          throw new Error("Server is required");
+        }
 
         if (requireAuth && !auth.isAuthenticated) {
           return (
@@ -107,13 +120,15 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
           <PlaygroundDialog
             url={url ?? "/"}
             method={method ?? "get"}
-            server={
-              server ?? serverQuery.data?.schema.url ?? "https://example.com"
-            }
+            server={server}
             {...props}
           >
             <Button className="gap-2 items-center" variant="outline">
-              Open in Playground <CirclePlayIcon size={16} />
+              {children ?? (
+                <>
+                  Open in Playground <CirclePlayIcon size={16} />
+                </>
+              )}
             </Button>
           </PlaygroundDialog>
         );
@@ -124,67 +139,85 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
         return [];
       }
 
+      const match = matchPath(
+        { path: `${basePath}/:version?/:tag`, end: true },
+        path,
+      );
+
       try {
-        const data = await client.fetch(GetCategoriesQuery, {
-          type: config.type,
-          input: config.input,
-        });
+        const versionParam = match?.params.version;
+        const version = versionParam ?? getVersions(config).at(0);
+        const type = config.type;
+        const input =
+          config.type === "file" ? config.input[version!] : config.input;
+
+        const collapsible = config.loadTags === true || config.type === "url";
+        const collapsed = !config.loadTags && config.type !== "url";
 
-        const categories = data.schema.tags
-          .filter((tag) => tag.operations.length > 0)
-          .map<SidebarItem>((tag) => ({
-            type: "category",
-            label: tag.name || "Other endpoints",
-            collapsible: true,
-            collapsed: false,
-            items: tag.operations.map((operation) => ({
-              type: "link",
-              label: operation.summary ?? operation.path,
-              href: `#${operation.slug}`,
-              badge: {
-                label: operation.method,
-                color: MethodColorMap[operation.method.toLowerCase()]!,
-              },
-            })),
-          }));
-
-        categories.unshift({
-          type: "link",
-          label: "Overview",
-          href: "#description",
+        // find  tag name by slug in config.tagPages
+        const tagName = config.tagPages?.find(
+          (tag) => slugify(tag) === match?.params.tag,
+        );
+
+        const [tagData, operationsData] = await Promise.all([
+          client.fetch(GetCategoriesQuery, { type, input }),
+          client.fetch(GetOperationsQuery, {
+            type,
+            input,
+            tag: !config.loadTags ? tagName : undefined,
+          }),
+        ]);
+
+        const categories = tagData.schema.tags.flatMap((tag) => {
+          const categoryPath = joinUrl(
+            basePath,
+            versionParam,
+            slugify(tag.name),
+          );
+
+          const operations = operationsData.schema.operations.filter(
+            (operation) =>
+              operation.tags?.length !== 0 &&
+              operation.tags?.map((t) => t.name).includes(tag.name),
+          );
+
+          // skip empty categories
+          if (config.loadTags && operations.length === 0) {
+            return [];
+          }
+
+          return createSidebarCategory({
+            label: tag.name,
+            path: categoryPath,
+            operations:
+              match?.params.tag !== UNTAGGED_PATH || config.loadTags
+                ? operations
+                : [],
+            collapsible,
+            collapsed,
+          });
         });
 
+        if (operationsData.schema.untagged.length > 0) {
+          categories.push(
+            createSidebarCategory({
+              label: "Other endpoints",
+              path: joinUrl(basePath, versionParam, UNTAGGED_PATH),
+              operations:
+                match?.params.tag === UNTAGGED_PATH || config.loadTags
+                  ? operationsData.schema.untagged
+                  : [],
+              collapsible,
+              collapsed,
+            }),
+          );
+        }
+
         return categories;
       } catch {
         return [];
       }
     },
-    getRoutes: () =>
-      [
-        {
-          async lazy() {
-            const { OpenApiRoute } = await import("./Route.js");
-            return {
-              element: <OpenApiRoute client={client} config={config} />,
-            };
-          },
-          children: [
-            {
-              path: basePath,
-              children: [
-                {
-                  index: true,
-                  async lazy() {
-                    const { OperationList } = await import(
-                      "./OperationList.js"
-                    );
-                    return { element: <OperationList /> };
-                  },
-                },
-              ],
-            },
-          ],
-        },
-      ] satisfies RouteObject[],
+    getRoutes: () => getRoutes({ basePath, config, client }),
   };
 };

package/src/lib/plugins/openapi/interfaces.ts

@@ -1,10 +1,35 @@
+type DynamicInput = () => Promise<unknown>;
+
 type OasSource =
   | { type: "url"; input: string }
-  | { type: "file"; input: () => Promise<unknown> }
+  | { type: "file"; input: { [version: string]: DynamicInput } }
+  | { type: "raw"; input: string };
+
+export type ContextOasSource =
+  | { type: "url"; input: string }
+  | { type: "file"; input: DynamicInput }
   | { type: "raw"; input: string };
 
 export type OasPluginConfig = {
   server?: string;
   navigationId?: string;
   skipPreload?: boolean;
-} & OasSource;
+  tagPages?: Array<string>;
+  loadTags?: boolean;
+} & OasPluginConfigOptions &
+  OasSource;
+
+export type OasPluginConfigOptions = {
+  options?: {
+    examplesDefaultLanguage?: string;
+  };
+};
+
+export type OasPluginContext = {
+  server?: string;
+  navigationId?: string;
+  skipPreload?: boolean;
+  version?: string;
+  versions: Record<string, string>;
+} & ContextOasSource &
+  OasPluginConfigOptions;