@lukoweb/apitogo 0.1.23 → 0.1.37

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

@@ -1,2 +1,2 @@
-export * from "./fragment-masking.js";
-export * from "./gql.js";
+export * from "./fragment-masking.js";
+export * from "./gql.js";

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

@@ -1,221 +1,221 @@
-import { CirclePlayIcon } from "lucide-react";
-import { type PropsWithChildren, Suspense, lazy } from "react";
-import { matchPath } from "react-router";
-import type { ApitogoPlugin } from "../../core/plugins.js";
-import { Button } from "../../ui/Button.js";
-import { joinUrl } from "../../util/joinUrl.js";
-import { GraphQLClient } from "./client/GraphQLClient.js";
-import { createQuery } from "./client/useCreateQuery.js";
-import type { GetNavigationOperationsQuery as GetNavigationOperationsQueryResult } from "./graphql/graphql.js";
-import { graphql } from "./graphql/index.js";
-import type { OasPluginConfig } from "./interfaces.js";
-import type { PlaygroundContentProps } from "./playground/Playground.js";
-import { buildTagCategories } from "./util/buildTagCategories.js";
-import { createNavigationCategory } from "./util/createNavigationCategory.js";
-import { getRoutes, getVersionMetadata } from "./util/getRoutes.js";
-
-const PlaygroundDialog = lazy(() =>
-  import("./playground/PlaygroundDialog.js").then((m) => ({
-    default: m.PlaygroundDialog,
-  })),
-);
-
-export const GetNavigationOperationsQuery = graphql(`
-  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {
-    schema(input: $input, type: $type) {
-      extensions
-      tags {
-        slug
-        name
-        extensions
-        operations {
-          summary
-          slug
-          method
-          operationId
-          path
-        }
-      }
-      components {
-        schemas {
-          __typename
-        }
-      }
-    }
-  }
-`);
-
-export type OperationResult =
-  GetNavigationOperationsQueryResult["schema"]["tags"][number]["operations"][number];
-
-export type OpenApiPluginOptions = OasPluginConfig;
-
-export const UNTAGGED_PATH = "~endpoints";
-
-export const openApiPlugin = (config: OasPluginConfig): ApitogoPlugin => {
-  const basePath = joinUrl(config.path);
-  const client = new GraphQLClient(config);
-
-  return {
-    getHead: () => {
-      if (config.type === "url" && !config.skipPreload) {
-        const urls = Array.isArray(config.input)
-          ? config.input.map((v) => v.input)
-          : [config.input];
-
-        return urls.map((url) => (
-          <link
-            key={url}
-            href={url}
-            rel="preload"
-            as="fetch"
-            crossOrigin="anonymous"
-          />
-        ));
-      }
-
-      if (config.server) {
-        return <link rel="preconnect" href={config.server} />;
-      }
-    },
-    getMdxComponents: () => ({
-      OpenPlaygroundButton: ({
-        server,
-        method = "get",
-        url = "/",
-        children,
-        ...props
-      }: PropsWithChildren<Partial<PlaygroundContentProps>>) => {
-        if (!server) {
-          throw new Error("Server is required");
-        }
-
-        return (
-          <Suspense>
-            <PlaygroundDialog
-              url={url}
-              method={method}
-              server={server}
-              {...props}
-            >
-              <Button className="gap-2 items-center" variant="outline">
-                {children ?? (
-                  <>
-                    Open in Playground
-                    <CirclePlayIcon size={16} />
-                  </>
-                )}
-              </Button>
-            </PlaygroundDialog>
-          </Suspense>
-        );
-      },
-    }),
-    getNavigation: async (path, context) => {
-      if (!matchPath({ path: basePath, end: false }, path)) {
-        return [];
-      }
-
-      try {
-        const { versions } = getVersionMetadata(config);
-
-        const versionParam = versions.find((v) =>
-          matchPath({ path: joinUrl(basePath, v), end: false }, path),
-        );
-
-        const version = versionParam ?? versions.at(0);
-        const { type } = config;
-
-        const input = Array.isArray(config.input)
-          ? (config.input.find((v) => v.path === version)?.input ??
-            config.input[0]?.input)
-          : config.input;
-
-        const query = createQuery(client, GetNavigationOperationsQuery, {
-          type,
-          input,
-        });
-        const data = await context.queryClient.ensureQueryData(query);
-
-        const tagCategories = new Map(
-          data.schema.tags
-            .filter((tag) => tag.name && tag.operations.length > 0)
-            .map((tag) => {
-              if (!tag.name) {
-                throw new Error(`Tag ${tag.slug} has no name`);
-              }
-
-              const categoryPath = joinUrl(basePath, versionParam, tag.slug);
-
-              const isCollapsed =
-                tag.extensions?.["x-apitogo-collapsed"] ??
-                tag.extensions?.["x-zudoku-collapsed"] ??
-                !config.options?.expandAllTags;
-              const isCollapsible =
-                tag.extensions?.["x-apitogo-collapsible"] ??
-                tag.extensions?.["x-zudoku-collapsible"] ??
-                true;
-
-              return [
-                tag.name,
-                createNavigationCategory({
-                  label: tag.extensions?.["x-displayName"] ?? tag.name,
-                  path: categoryPath,
-                  operations: tag.operations,
-                  collapsed: isCollapsed,
-                  collapsible: isCollapsible,
-                }),
-              ];
-            }),
-        );
-
-        const tagGroups =
-          (data.schema.extensions?.["x-tagGroups"] as
-            | { name: string; tags: string[] }[]
-            | undefined) ?? [];
-
-        const categories = buildTagCategories({
-          tagCategories,
-          tagGroups,
-          expandAllTags: config.options?.expandAllTags,
-        });
-
-        if (config.options?.showInfoPage !== false) {
-          categories.unshift({
-            type: "link" as const,
-            to: joinUrl(basePath, versionParam),
-            label: "Information",
-          });
-        }
-
-        const untaggedOperations = data.schema.tags.find(
-          (tag) => !tag.name,
-        )?.operations;
-
-        if (untaggedOperations && untaggedOperations.length > 0) {
-          categories.push(
-            createNavigationCategory({
-              label: categories.length === 0 ? "Endpoints" : "Other endpoints",
-              path: joinUrl(basePath, versionParam, UNTAGGED_PATH),
-              operations: untaggedOperations,
-              collapsed: !config.options?.expandAllTags,
-            }),
-          );
-        }
-
-        if (data.schema.components?.schemas?.length) {
-          categories.push({
-            type: "link",
-            label: "Schemas",
-            to: joinUrl(basePath, versionParam, "~schemas"),
-          });
-        }
-
-        return categories;
-      } catch {
-        return [];
-      }
-    },
-    getRoutes: () => getRoutes({ basePath, config, client }),
-  };
-};
+import { CirclePlayIcon } from "lucide-react";
+import { type PropsWithChildren, Suspense, lazy } from "react";
+import { matchPath } from "react-router";
+import type { ApitogoPlugin } from "../../core/plugins.js";
+import { Button } from "../../ui/Button.js";
+import { joinUrl } from "../../util/joinUrl.js";
+import { GraphQLClient } from "./client/GraphQLClient.js";
+import { createQuery } from "./client/useCreateQuery.js";
+import type { GetNavigationOperationsQuery as GetNavigationOperationsQueryResult } from "./graphql/graphql.js";
+import { graphql } from "./graphql/index.js";
+import type { OasPluginConfig } from "./interfaces.js";
+import type { PlaygroundContentProps } from "./playground/Playground.js";
+import { buildTagCategories } from "./util/buildTagCategories.js";
+import { createNavigationCategory } from "./util/createNavigationCategory.js";
+import { getRoutes, getVersionMetadata } from "./util/getRoutes.js";
+
+const PlaygroundDialog = lazy(() =>
+  import("./playground/PlaygroundDialog.js").then((m) => ({
+    default: m.PlaygroundDialog,
+  })),
+);
+
+export const GetNavigationOperationsQuery = graphql(`
+  query GetNavigationOperations($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      extensions
+      tags {
+        slug
+        name
+        extensions
+        operations {
+          summary
+          slug
+          method
+          operationId
+          path
+        }
+      }
+      components {
+        schemas {
+          __typename
+        }
+      }
+    }
+  }
+`);
+
+export type OperationResult =
+  GetNavigationOperationsQueryResult["schema"]["tags"][number]["operations"][number];
+
+export type OpenApiPluginOptions = OasPluginConfig;
+
+export const UNTAGGED_PATH = "~endpoints";
+
+export const openApiPlugin = (config: OasPluginConfig): ApitogoPlugin => {
+  const basePath = joinUrl(config.path);
+  const client = new GraphQLClient(config);
+
+  return {
+    getHead: () => {
+      if (config.type === "url" && !config.skipPreload) {
+        const urls = Array.isArray(config.input)
+          ? config.input.map((v) => v.input)
+          : [config.input];
+
+        return urls.map((url) => (
+          <link
+            key={url}
+            href={url}
+            rel="preload"
+            as="fetch"
+            crossOrigin="anonymous"
+          />
+        ));
+      }
+
+      if (config.server) {
+        return <link rel="preconnect" href={config.server} />;
+      }
+    },
+    getMdxComponents: () => ({
+      OpenPlaygroundButton: ({
+        server,
+        method = "get",
+        url = "/",
+        children,
+        ...props
+      }: PropsWithChildren<Partial<PlaygroundContentProps>>) => {
+        if (!server) {
+          throw new Error("Server is required");
+        }
+
+        return (
+          <Suspense>
+            <PlaygroundDialog
+              url={url}
+              method={method}
+              server={server}
+              {...props}
+            >
+              <Button className="gap-2 items-center" variant="outline">
+                {children ?? (
+                  <>
+                    Open in Playground
+                    <CirclePlayIcon size={16} />
+                  </>
+                )}
+              </Button>
+            </PlaygroundDialog>
+          </Suspense>
+        );
+      },
+    }),
+    getNavigation: async (path, context) => {
+      if (!matchPath({ path: basePath, end: false }, path)) {
+        return [];
+      }
+
+      try {
+        const { versions } = getVersionMetadata(config);
+
+        const versionParam = versions.find((v) =>
+          matchPath({ path: joinUrl(basePath, v), end: false }, path),
+        );
+
+        const version = versionParam ?? versions.at(0);
+        const { type } = config;
+
+        const input = Array.isArray(config.input)
+          ? (config.input.find((v) => v.path === version)?.input ??
+            config.input[0]?.input)
+          : config.input;
+
+        const query = createQuery(client, GetNavigationOperationsQuery, {
+          type,
+          input,
+        });
+        const data = await context.queryClient.ensureQueryData(query);
+
+        const tagCategories = new Map(
+          data.schema.tags
+            .filter((tag) => tag.name && tag.operations.length > 0)
+            .map((tag) => {
+              if (!tag.name) {
+                throw new Error(`Tag ${tag.slug} has no name`);
+              }
+
+              const categoryPath = joinUrl(basePath, versionParam, tag.slug);
+
+              const isCollapsed =
+                tag.extensions?.["x-apitogo-collapsed"] ??
+                tag.extensions?.["x-zudoku-collapsed"] ??
+                !config.options?.expandAllTags;
+              const isCollapsible =
+                tag.extensions?.["x-apitogo-collapsible"] ??
+                tag.extensions?.["x-zudoku-collapsible"] ??
+                true;
+
+              return [
+                tag.name,
+                createNavigationCategory({
+                  label: tag.extensions?.["x-displayName"] ?? tag.name,
+                  path: categoryPath,
+                  operations: tag.operations,
+                  collapsed: isCollapsed,
+                  collapsible: isCollapsible,
+                }),
+              ];
+            }),
+        );
+
+        const tagGroups =
+          (data.schema.extensions?.["x-tagGroups"] as
+            | { name: string; tags: string[] }[]
+            | undefined) ?? [];
+
+        const categories = buildTagCategories({
+          tagCategories,
+          tagGroups,
+          expandAllTags: config.options?.expandAllTags,
+        });
+
+        if (config.options?.showInfoPage !== false) {
+          categories.unshift({
+            type: "link" as const,
+            to: joinUrl(basePath, versionParam),
+            label: "Information",
+          });
+        }
+
+        const untaggedOperations = data.schema.tags.find(
+          (tag) => !tag.name,
+        )?.operations;
+
+        if (untaggedOperations && untaggedOperations.length > 0) {
+          categories.push(
+            createNavigationCategory({
+              label: categories.length === 0 ? "Endpoints" : "Other endpoints",
+              path: joinUrl(basePath, versionParam, UNTAGGED_PATH),
+              operations: untaggedOperations,
+              collapsed: !config.options?.expandAllTags,
+            }),
+          );
+        }
+
+        if (data.schema.components?.schemas?.length) {
+          categories.push({
+            type: "link",
+            label: "Schemas",
+            to: joinUrl(basePath, versionParam, "~schemas"),
+          });
+        }
+
+        return categories;
+      } catch {
+        return [];
+      }
+    },
+    getRoutes: () => getRoutes({ basePath, config, client }),
+  };
+};

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

@@ -1,100 +1,100 @@
-import type { AuthState } from "../../authentication/state.js";
-import type { ZudokuContext } from "../../core/ZudokuContext.js";
-import type { SchemaImports } from "../../oas/graphql/index.js";
-import type { OperationsFragmentFragment } from "./graphql/graphql.js";
-
-type DynamicInput = () => Promise<unknown>;
-
-export type VersionedInput<T = string> = {
-  path: string;
-  version?: string;
-  downloadUrl?: string;
-  label?: string;
-  input: T;
-  hasUntaggedOperations?: boolean;
-  tagPages?: string[];
-};
-
-type OasSource =
-  | { type: "url"; input: string | VersionedInput[] }
-  | { type: "file"; input: VersionedInput<DynamicInput>[] }
-  | { type: "raw"; input: string };
-
-export type ContextOasSource = {
-  type: "url" | "file" | "raw";
-  input: string | DynamicInput;
-};
-
-type Example = {
-  name: string;
-  description?: string | null;
-  externalValue?: string | null;
-  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-  value?: any | null;
-  summary?: string | null;
-};
-
-type Content = {
-  mediaType: string;
-  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-  schema?: any | null;
-  encoding?: Array<{
-    name: string;
-  }> | null;
-  examples?: Array<Example> | null;
-};
-
-export type TransformExamplesFn = (options: {
-  content: Content[];
-  context: ZudokuContext;
-  auth: AuthState;
-  operation: OperationsFragmentFragment;
-  type: "request" | "response";
-}) => Content[];
-
-export type GenerateCodeSnippetFn = (options: {
-  selectedLang: string;
-  selectedServer: string;
-  context: ZudokuContext;
-  auth: AuthState;
-  operation: OperationsFragmentFragment;
-  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-  example?: any | null;
-}) => string | false;
-
-type BaseOasConfig = {
-  server?: string;
-  path?: string;
-  skipPreload?: boolean;
-  tagPages?: Array<string>;
-  schemaImports?: SchemaImports;
-  options?: {
-    examplesLanguage?: string;
-    supportedLanguages?: { value: string; label: string }[];
-    disablePlayground?: boolean;
-    disableSidecar?: boolean;
-    showVersionSelect?: "always" | "if-available" | "hide";
-    expandAllTags?: boolean;
-    showInfoPage?: boolean;
-    schemaDownload?: {
-      enabled: boolean;
-    };
-    transformExamples?: TransformExamplesFn;
-    generateCodeSnippet?: GenerateCodeSnippetFn;
-  };
-};
-
-export type OasPluginConfig = BaseOasConfig & OasSource;
-
-export type VersionEntry = {
-  path: string;
-  label: string;
-  downloadUrl?: string;
-  tagPages?: string[];
-};
-
-export type OasPluginContext = BaseOasConfig &
-  ContextOasSource & {
-    version?: string;
-    versions: Record<string, VersionEntry>;
-  };
+import type { AuthState } from "../../authentication/state.js";
+import type { ZudokuContext } from "../../core/ZudokuContext.js";
+import type { SchemaImports } from "../../oas/graphql/index.js";
+import type { OperationsFragmentFragment } from "./graphql/graphql.js";
+
+type DynamicInput = () => Promise<unknown>;
+
+export type VersionedInput<T = string> = {
+  path: string;
+  version?: string;
+  downloadUrl?: string;
+  label?: string;
+  input: T;
+  hasUntaggedOperations?: boolean;
+  tagPages?: string[];
+};
+
+type OasSource =
+  | { type: "url"; input: string | VersionedInput[] }
+  | { type: "file"; input: VersionedInput<DynamicInput>[] }
+  | { type: "raw"; input: string };
+
+export type ContextOasSource = {
+  type: "url" | "file" | "raw";
+  input: string | DynamicInput;
+};
+
+type Example = {
+  name: string;
+  description?: string | null;
+  externalValue?: string | null;
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+  value?: any | null;
+  summary?: string | null;
+};
+
+type Content = {
+  mediaType: string;
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+  schema?: any | null;
+  encoding?: Array<{
+    name: string;
+  }> | null;
+  examples?: Array<Example> | null;
+};
+
+export type TransformExamplesFn = (options: {
+  content: Content[];
+  context: ZudokuContext;
+  auth: AuthState;
+  operation: OperationsFragmentFragment;
+  type: "request" | "response";
+}) => Content[];
+
+export type GenerateCodeSnippetFn = (options: {
+  selectedLang: string;
+  selectedServer: string;
+  context: ZudokuContext;
+  auth: AuthState;
+  operation: OperationsFragmentFragment;
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+  example?: any | null;
+}) => string | false;
+
+type BaseOasConfig = {
+  server?: string;
+  path?: string;
+  skipPreload?: boolean;
+  tagPages?: Array<string>;
+  schemaImports?: SchemaImports;
+  options?: {
+    examplesLanguage?: string;
+    supportedLanguages?: { value: string; label: string }[];
+    disablePlayground?: boolean;
+    disableSidecar?: boolean;
+    showVersionSelect?: "always" | "if-available" | "hide";
+    expandAllTags?: boolean;
+    showInfoPage?: boolean;
+    schemaDownload?: {
+      enabled: boolean;
+    };
+    transformExamples?: TransformExamplesFn;
+    generateCodeSnippet?: GenerateCodeSnippetFn;
+  };
+};
+
+export type OasPluginConfig = BaseOasConfig & OasSource;
+
+export type VersionEntry = {
+  path: string;
+  label: string;
+  downloadUrl?: string;
+  tagPages?: string[];
+};
+
+export type OasPluginContext = BaseOasConfig &
+  ContextOasSource & {
+    version?: string;
+    versions: Record<string, VersionEntry>;
+  };

package/src/lib/plugins/openapi/playground/Headers.tsx

@@ -25,12 +25,12 @@ import type { Header, PlaygroundForm } from "./Playground.js";
 import { useKeyValueFieldManager } from "./request-panel/useKeyValueFieldManager.js";
 
 // prettier-ignore
-const headerOptions = Object.freeze([
-  "Accept", "Accept-Encoding", "Accept-Language", "Authorization", "Cache-Control", "Connection",
-  "Content-Disposition", "Content-Encoding", "Content-Language", "Content-Length", "Content-Range",
-  "Content-Security-Policy", "Content-Type", "Cookie", "Date", "ETag", "Expires", "Host",
-  "If-Modified-Since", "Location", "Origin", "Pragma", "Referer", "Set-Cookie", "User-Agent",
-  "X-Requested-With",
+const headerOptions = Object.freeze([
+  "Accept", "Accept-Encoding", "Accept-Language", "Authorization", "Cache-Control", "Connection",
+  "Content-Disposition", "Content-Encoding", "Content-Language", "Content-Length", "Content-Range",
+  "Content-Security-Policy", "Content-Type", "Cookie", "Date", "ETag", "Expires", "Host",
+  "If-Modified-Since", "Location", "Origin", "Pragma", "Referer", "Set-Cookie", "User-Agent",
+  "X-Requested-With",
 ]);
 
 export const Headers = ({