@mehdad67/apitogo 0.1.24

package/src/lib/plugins/openapi/schema/UnionView.tsx

@@ -0,0 +1,132 @@
+import { useState } from "react";
+import type { SchemaObject } from "../../../oas/parser/index.js";
+import { Badge } from "../../../ui/Badge.js";
+import { Frame, FramePanel } from "../../../ui/Frame.js";
+import { cn } from "../../../util/cn.js";
+import { SchemaView } from "./SchemaView.js";
+import {
+  decideExclusivity,
+  labelForVariant,
+  quickGuards,
+  unionVariants,
+} from "./union-helpers.js";
+
+const DecisionTable = ({
+  variants,
+  schema,
+  selectedVariant,
+  onSelectVariant,
+}: {
+  variants: SchemaObject[];
+  schema: SchemaObject;
+  selectedVariant: string;
+  onSelectVariant: (label: string) => void;
+}) => {
+  const rows = variants.map((v, i) => ({
+    label: labelForVariant(i, v),
+    guards: quickGuards(v, schema),
+  }));
+
+  return (
+    <div className="flex flex-col gap-2 text-sm">
+      <h4 className="font-medium">Decision Table</h4>
+      <div className="border rounded-md overflow-hidden">
+        <table className="w-full">
+          <thead>
+            <tr className="border-b bg-muted/50">
+              <th className="text-left p-2 font-medium">Variant</th>
+              <th className="text-left p-2 font-medium">Matching Criteria</th>
+            </tr>
+          </thead>
+          <tbody className="divide-y">
+            {rows.map((row) => (
+              <tr key={row.label} className="hover:bg-muted/30">
+                <td className="p-2 font-medium">
+                  <button
+                    type="button"
+                    className={cn(
+                      "hover:underline",
+                      selectedVariant === row.label && "text-primary",
+                    )}
+                    onClick={() => onSelectVariant(row.label)}
+                  >
+                    {row.label}
+                  </button>
+                </td>
+                <td className="p-2 text-muted-foreground text-xs">
+                  {row.guards.length > 0
+                    ? row.guards.join(" · ")
+                    : "No specific criteria"}
+                </td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  );
+};
+
+export const UnionView = ({
+  schema,
+  cardHeader,
+}: {
+  schema: SchemaObject;
+  cardHeader?: React.ReactNode;
+}) => {
+  const mode = Array.isArray(schema.oneOf)
+    ? "oneOf"
+    : Array.isArray(schema.anyOf)
+      ? "anyOf"
+      : undefined;
+
+  const variants = mode ? unionVariants(schema) : [];
+  const [selectedVariant, setSelectedVariant] = useState(() =>
+    variants[0] ? labelForVariant(0, variants[0]) : "",
+  );
+
+  if (!mode) return null;
+
+  const exclusivity = decideExclusivity(schema);
+
+  const semanticsMessage =
+    exclusivity === "exactly-one" ? (
+      <>
+        Exactly one variant <b>must match</b>.
+      </>
+    ) : (
+      <>
+        At least one variant <b>must match</b>. Multiple variants{" "}
+        <i>may match</i> simultaneously.
+      </>
+    );
+
+  const currentVariantIndex = variants.findIndex(
+    (v, i) => labelForVariant(i, v) === selectedVariant,
+  );
+  const currentVariant =
+    currentVariantIndex >= 0 ? variants[currentVariantIndex] : null;
+
+  return (
+    <Frame>
+      {cardHeader}
+      <FramePanel className="text-sm flex flex-col gap-4">
+        <div className="flex items-center gap-2">
+          <Badge variant="outline">{mode}</Badge>
+          <div className="flex-1 p-2">
+            <span className="text-sm">{semanticsMessage}</span>
+          </div>
+        </div>
+
+        <DecisionTable
+          variants={variants}
+          schema={schema}
+          selectedVariant={selectedVariant}
+          onSelectVariant={setSelectedVariant}
+        />
+        <strong>Properties for {selectedVariant}:</strong>
+        {currentVariant && <SchemaView schema={currentVariant} />}
+      </FramePanel>
+    </Frame>
+  );
+};

package/src/lib/plugins/openapi/schema/union-helpers.ts

@@ -0,0 +1,123 @@
+import type { SchemaObject } from "../../../oas/parser/index.js";
+
+export type FieldSignature = {
+  type?: SchemaObject["type"];
+  const?: unknown;
+  enum?: unknown[];
+  format?: string;
+  pattern?: string;
+  minimum?: number;
+  maximum?: number;
+  exclusiveMinimum?: boolean | number;
+  exclusiveMaximum?: boolean | number;
+  minLength?: number;
+  maxLength?: number;
+  minItems?: number;
+  maxItems?: number;
+  itemsType?: string | string[];
+  additionalProps?: "true" | "false" | "schema";
+};
+
+export type FieldDoc = {
+  name: string;
+  humanType: string;
+  description?: string;
+  requiredInAll: boolean;
+};
+
+export const unionVariants = (schema: SchemaObject): SchemaObject[] => {
+  const variants = (schema.oneOf ?? schema.anyOf ?? []) as SchemaObject[];
+
+  // If parent schema has properties that variants don't, merge them
+  // This handles the pattern where anyOf/oneOf is used just for required field combinations
+  if (schema.properties && Object.keys(schema.properties).length > 0) {
+    return variants.map((variant) => {
+      // If variant doesn't define its own properties or type, inherit from parent
+      const shouldInherit =
+        !variant.properties &&
+        !variant.type &&
+        !variant.oneOf &&
+        !variant.anyOf;
+
+      if (shouldInherit) {
+        return {
+          ...variant,
+          type: "object" as const,
+          properties: schema.properties,
+          required: variant.required ?? schema.required,
+        };
+      }
+
+      return variant;
+    });
+  }
+
+  return variants;
+};
+
+export const decideExclusivity = (
+  schema: SchemaObject,
+): "exactly-one" | "at-least-one" => {
+  if (Array.isArray(schema.oneOf)) return "exactly-one";
+
+  const discriminator = schema.discriminator?.propertyName;
+  if (!discriminator) return "at-least-one";
+
+  const variants = unionVariants(schema);
+  const seen = new Set<string>();
+
+  for (const variant of variants) {
+    const prop = variant.properties?.[discriminator];
+
+    const value =
+      prop?.const ??
+      (Array.isArray(prop?.enum) && prop.enum.length === 1
+        ? String(prop.enum[0])
+        : undefined);
+
+    if (value == null || seen.has(String(value))) return "at-least-one";
+    seen.add(String(value));
+  }
+
+  return "exactly-one";
+};
+
+export const labelForVariant = (index: number, variant: SchemaObject) =>
+  variant.title?.trim() || `Variant ${index + 1}`;
+
+export const quickGuards = (variant: SchemaObject, root?: SchemaObject) => {
+  const guards: string[] = [];
+
+  if (variant.type) {
+    guards.push(
+      `type = ${Array.isArray(variant.type) ? variant.type.join("|") : variant.type}`,
+    );
+  }
+
+  const discriminator = root?.discriminator?.propertyName;
+  if (discriminator) {
+    const discriminatorProp = variant.properties?.[discriminator] as
+      | SchemaObject
+      | undefined;
+
+    const discriminatorValue =
+      discriminatorProp?.const ??
+      (Array.isArray(discriminatorProp?.enum) &&
+      discriminatorProp.enum.length === 1
+        ? discriminatorProp.enum[0]
+        : undefined);
+
+    if (discriminatorValue !== undefined) {
+      guards.push(`${discriminator}=${JSON.stringify(discriminatorValue)}`);
+    }
+  }
+
+  const required = (variant.required ?? []).filter((k) => k !== discriminator);
+  if (required.length) {
+    const head = required.slice(0, 3).join(", ");
+    const more = required.length > 3 ? ` +${required.length - 3} more` : "";
+    guards.push(`requires: ${head}${more}`);
+  }
+
+  return guards;
+};

package/src/lib/plugins/openapi/schema/utils.ts

@@ -0,0 +1,49 @@
+import {
+  CIRCULAR_REF,
+  SCHEMA_REF_PREFIX,
+} from "../../../oas/graphql/constants.js";
+import type {
+  ArraySchemaObject,
+  SchemaObject,
+} from "../../../oas/parser/index.js";
+
+export const isBasicType = (
+  type: unknown,
+): type is "string" | "number" | "boolean" | "integer" | "null" =>
+  (typeof type === "string" &&
+    ["string", "number", "boolean", "integer", "null"].includes(type)) ||
+  (Array.isArray(type) && type.every(isBasicType));
+
+export const isArrayType = (value: SchemaObject): value is ArraySchemaObject =>
+  value.type === "array" ||
+  // schema.type might be an array of types, so we need to check if "array" is one of them
+  (Array.isArray(value.type) && value.type.includes("array"));
+
+export const isComplexType = (value?: SchemaObject) =>
+  value &&
+  ((value.type === "object" &&
+    Object.keys(value.properties ?? {}).length > 0) ||
+    (value.type === "array" &&
+      typeof value.items === "object" &&
+      (!value.items.type || value.items.type === "object")));
+
+export const isCircularRef = (schema: unknown): schema is string =>
+  typeof schema === "string" &&
+  (schema.startsWith(CIRCULAR_REF) || schema.startsWith(SCHEMA_REF_PREFIX));
+
+export const isArrayCircularRef = (
+  schema: SchemaObject,
+): schema is SchemaObject & { items: SchemaObject } =>
+  isArrayType(schema) && "items" in schema && isCircularRef(schema.items);
+
+export const extractCircularRefInfo = (
+  ref?: string | SchemaObject,
+): string | undefined => {
+  if (typeof ref !== "string") return undefined;
+
+  if (ref.startsWith(SCHEMA_REF_PREFIX)) {
+    return ref.slice(SCHEMA_REF_PREFIX.length).split("/").pop();
+  }
+
+  return ref.split(":")[1];
+};

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

@@ -0,0 +1,36 @@
+import { useMemo } from "react";
+import { create } from "zustand";
+import { persist } from "zustand/middleware";
+
+interface SelectedServerState {
+  selectedServer?: string;
+  setSelectedServer: (newServer: string) => void;
+}
+
+export const useSelectedServerStore = create<SelectedServerState>()(
+  persist(
+    (set) => ({
+      selectedServer: undefined,
+      setSelectedServer: (newServer: string) =>
+        set({ selectedServer: newServer }),
+    }),
+    { name: "zudoku-selected-server" },
+  ),
+);
+
+/**
+ * Simple wrapper for `useSelectedServerStore` to fall back to first of the provided servers
+ */
+export const useSelectedServer = (servers: Array<{ url: string }>) => {
+  const { selectedServer, setSelectedServer } = useSelectedServerStore();
+
+  const finalSelectedServer = useMemo(
+    () =>
+      selectedServer && servers.some((s) => s.url === selectedServer)
+        ? selectedServer
+        : (servers.at(0)?.url ?? ""),
+    [selectedServer, servers],
+  );
+
+  return { selectedServer: finalSelectedServer, setSelectedServer };
+};

package/src/lib/plugins/openapi/util/buildTagCategories.ts

@@ -0,0 +1,54 @@
+import type { NavigationItem } from "../../../../config/validators/NavigationSchema.js";
+
+type TagGroup = { name: string; tags: string[] };
+
+type BuildTagCategoriesOptions = {
+  tagCategories: Map<string, NavigationItem>;
+  tagGroups: TagGroup[];
+  expandAllTags?: boolean;
+};
+
+// Merges tags and x-tagGroups with the same name into a single sidebar
+// category (mimics OpenAPI 3.2.0 "Enhanced tags" behaviour).
+export const buildTagCategories = ({
+  tagCategories,
+  tagGroups,
+  expandAllTags,
+}: BuildTagCategoriesOptions): NavigationItem[] => {
+  const consumedTags = new Set<string>();
+
+  const groupedCategories = tagGroups.flatMap<NavigationItem>((group) => {
+    // Use a same-named tag as base so its operations appear first
+    const matchingTag = tagCategories.get(group.name);
+    const base = matchingTag?.type === "category" ? matchingTag : undefined;
+
+    if (base) consumedTags.add(group.name);
+
+    // Exclude group's own name to avoid nesting a tag inside itself
+    const childTags = group.tags.flatMap((name) => {
+      if (name === group.name) return [];
+      const tag = tagCategories.get(name);
+      if (!tag) return [];
+      consumedTags.add(name);
+      return tag;
+    });
+
+    if (!base && childTags.length === 0) return [];
+
+    return {
+      ...base,
+      type: "category",
+      label: base?.label ?? group.name,
+      items: [...(base?.items ?? []), ...childTags],
+      collapsible: base?.collapsible ?? true,
+      collapsed: base?.collapsed ?? !expandAllTags,
+    };
+  });
+
+  // Tags not claimed by any group appear as standalone entries
+  const ungroupedCategories = Array.from(tagCategories.entries())
+    .filter(([name]) => !consumedTags.has(name))
+    .map(([, cat]) => cat);
+
+  return [...groupedCategories, ...ungroupedCategories];
+};

package/src/lib/plugins/openapi/util/createHttpSnippet.ts

@@ -0,0 +1,135 @@
+import { HTTPSnippet } from "@zudoku/httpsnippet";
+import type { OperationsFragmentFragment } from "../graphql/graphql.js";
+
+const toFormDataParams = (text?: string) => {
+  const stringify = (v: unknown) =>
+    typeof v === "string" ? v : JSON.stringify(v);
+
+  try {
+    const obj = text && JSON.parse(text);
+    if (typeof obj !== "object" || !obj) return [];
+
+    return Object.entries(obj).flatMap(([name, value]) => {
+      const values = Array.isArray(value) ? value : [value];
+      return values.map((v) => ({ name, value: stringify(v) }));
+    });
+  } catch {
+    return [];
+  }
+};
+
+export const createHttpSnippet = ({
+  operation,
+  selectedServer,
+  exampleBody,
+}: {
+  operation: OperationsFragmentFragment;
+  selectedServer: string;
+  exampleBody: {
+    mimeType: string;
+    text?: string;
+  };
+}) => {
+  const isMultipart =
+    exampleBody.mimeType === "multipart/form-data" ||
+    exampleBody.mimeType === "application/x-www-form-urlencoded";
+
+  const postData = isMultipart
+    ? {
+        mimeType: exampleBody.mimeType,
+        params: toFormDataParams(exampleBody.text),
+      }
+    : exampleBody;
+
+  return new HTTPSnippet({
+    method: operation.method.toUpperCase(),
+    url:
+      selectedServer + operation.path.replaceAll("{", ":").replaceAll("}", ""),
+    postData,
+    headers: [
+      ...(exampleBody.text
+        ? [{ name: "Content-Type", value: exampleBody.mimeType }]
+        : []),
+      ...(operation.parameters
+        ?.filter((p) => p.in === "header" && p.required === true)
+        .map((p) => ({
+          name: p.name,
+          value:
+            p.schema?.default ??
+            p.examples?.find((x) => x.value)?.value ??
+            (p.schema?.type === "string"
+              ? "<string>"
+              : p.schema?.type === "number" || p.schema?.type === "integer"
+                ? "<number>"
+                : p.schema?.type === "boolean"
+                  ? "<bool>"
+                  : "<value>"),
+        })) ?? []),
+    ],
+    queryString:
+      operation.parameters
+        ?.filter((p) => p.in === "query" && p.required === true)
+        .map((p) => ({
+          name: p.name,
+          value:
+            p.schema?.default ??
+            p.examples?.find((x) => x.value)?.value ??
+            (p.schema?.type === "string"
+              ? "<string>"
+              : p.schema?.type === "number" || p.schema?.type === "integer"
+                ? "<number>"
+                : p.schema?.type === "boolean"
+                  ? "<bool>"
+                  : "<value>"),
+        })) ?? [],
+    httpVersion: "",
+    cookies: [],
+    headersSize: 0,
+    bodySize: 0,
+  });
+};
+
+export const getConverted = (snippet: HTTPSnippet, option: string) => {
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+  let converted: any;
+  switch (option) {
+    case "shell":
+      converted = snippet.convert("shell", "curl");
+      break;
+    case "js":
+      converted = snippet.convert("javascript", "fetch");
+      break;
+    case "python":
+      converted = snippet.convert("python", "requests");
+      break;
+    case "java":
+      converted = snippet.convert("java", "okhttp");
+      break;
+    case "go":
+      converted = snippet.convert("go", "native");
+      break;
+    case "csharp":
+      converted = snippet.convert("csharp", "httpclient");
+      break;
+    case "kotlin":
+      converted = snippet.convert("kotlin", "okhttp");
+      break;
+    case "objc":
+      converted = snippet.convert("objc", "nsurlsession");
+      break;
+    case "php":
+      converted = snippet.convert("php", "http2");
+      break;
+    case "ruby":
+      converted = snippet.convert("ruby");
+      break;
+    case "swift":
+      converted = snippet.convert("swift");
+      break;
+    default:
+      converted = snippet.convert("shell");
+      break;
+  }
+
+  return converted ? converted[0] : "";
+};

package/src/lib/plugins/openapi/util/createNavigationCategory.tsx

@@ -0,0 +1,39 @@
+import type { NavigationItem } from "../../../../config/validators/NavigationSchema.js";
+import type { OperationResult } from "../index.js";
+import { MethodColorMap } from "./methodColorMap.js";
+
+export const createNavigationCategory = ({
+  label,
+  path,
+  operations,
+  collapsible,
+  collapsed,
+}: {
+  label: string;
+  path: string;
+  operations: OperationResult[];
+  collapsible?: boolean;
+  collapsed?: boolean;
+}): NavigationItem => ({
+  type: "category",
+  label,
+  link: {
+    type: "doc" as const,
+    path,
+    file: path,
+    label,
+  },
+  collapsible,
+  collapsed,
+  items: operations.map((operation) => ({
+    type: "link" as const,
+    label: operation.summary ?? operation.path,
+    to: `${path}#${operation.slug}`,
+    badge: {
+      label: operation.method,
+      // biome-ignore lint/style/noNonNullAssertion: is guaranteed to be defined
+      color: MethodColorMap[operation.method.toLowerCase()]!,
+      invert: true,
+    },
+  })),
+});